title
stringlengths
0
125
url
stringlengths
67
206
markdown
stringlengths
55
86.1k
html
stringlengths
198
350k
crawlDate
stringlengths
24
24
Welcome to AWS Neuron — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/index.html
# Welcome to AWS Neuron — AWS Neuron Documentation ## Welcome to AWS Neuron[#](#welcome-to-aws-neuron "Permalink to this headline") AWS Neuron is the SDK used to run deep learning workloads on AWS Inferentia and AWS Trainium based instances. It supports customers in their end-to-end ML development lifecycle to build new models, train and optimize these models, and then deploy them for production. To learn about the model architectures currently supported on Inf1, Inf2, Trn1 and Trn1n instances, please see [Model Architecture Fit Guidelines](general/arch/model-architecture-fit.html#model-architecture-fit). To learn about upcoming capabilities, please view the [Roadmap](general/roadmap-readme.html#neuron-roadmap). AWS Neuron includes a deep learning compiler, runtime, and tools that are natively integrated into TensorFlow, PyTorch and Apache MXNet (incubating). The EC2 Trn1/Trn1n instances are optimized for the highest performance and best price-performance training in AWS. The EC2 Inf2 instances are designed for high-performance deep learning inference applications. With Neuron, customers can quickly start using Inf/Trn instances through services like Amazon Sagemaker, Amazon Elastic Container Service (ECS), Amazon Elastic Kubernetes Service (EKS), AWS Batch, and AWS Parallel Cluster. Check [Announcements](general/announcements/index.html#announcements-main) and check [Neuron 2.14.1 (09/26/2023)](release-notes/index.html#latest-neuron-release) for latest release. Overview - [Quick Links](general/quick-start/docs-quicklinks.html) - [Get Started with Neuron](general/quick-start/index.html) - [GitHub Samples](general/quick-start/github-samples.html) - [Performance](general/benchmarks/index.html) - [What’s New](release-notes/index.html) - [Announcements](general/announcements/index.html) User Guide - [Neuron Runtime](neuron-runtime/index.html) - [Neuron Compiler](compiler/index.html) - [Neuron C++ Custom Operators](neuron-customops/index.html) - [Neuron Tools](tools/index.html) - [Neuron Calculator](general/calculator/neuron-calculator.html) - [Setup Guide](general/setup/index.html) - [Containers Deployment](containers/index.html) - [Developer Flows](general/devflows/index.html)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"><meta content="Neuron SDK is powering AWS Inferentia and Trainium based instances, natively integrated into PyTorch and TensorFlow. Enabling you to quicky start with Amazon EC2, AWS Sagemaker, ECS and EKS." name="description"> <title>Welcome to AWS Neuron — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="_static/pygments.css"> <link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="_static/contentui.css"> <link rel="stylesheet" type="text/css" href="_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/doctools.js"></script> <script src="_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="_static/contentui.js"></script> <script src="_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="genindex.html"> <link rel="search" title="Search" href="search.html"> <link rel="next" title="Neuron Quick Links" href="general/quick-start/docs-quicklinks.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="#"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Findex.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="_sources/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Welcome to AWS Neuron</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <div class="section" id="welcome-to-aws-neuron"> <h1>Welcome to AWS Neuron<a class="headerlink" href="#welcome-to-aws-neuron" title="Permalink to this headline">#</a></h1> <p>AWS Neuron is the SDK used to run deep learning workloads on AWS Inferentia and AWS Trainium based instances. It supports customers in their end-to-end ML development lifecycle to build new models, train and optimize these models, and then deploy them for production. To learn about the model architectures currently supported on Inf1, Inf2, Trn1 and Trn1n instances, please see <a class="reference internal" href="general/arch/model-architecture-fit.html#model-architecture-fit"><span class="std std-ref">Model Architecture Fit Guidelines</span></a>. To learn about upcoming capabilities, please view the <a class="reference internal" href="general/roadmap-readme.html#neuron-roadmap"><span class="std std-ref">Roadmap</span></a>.</p> <p>AWS Neuron includes a deep learning compiler, runtime, and tools that are natively integrated into TensorFlow, PyTorch and Apache MXNet (incubating). The EC2 Trn1/Trn1n instances are optimized for the highest performance and best price-performance training in AWS. The EC2 Inf2 instances are designed for high-performance deep learning inference applications. With Neuron, customers can quickly start using Inf/Trn instances through services like Amazon Sagemaker, Amazon Elastic Container Service (ECS), Amazon Elastic Kubernetes Service (EKS), AWS Batch, and AWS Parallel Cluster.</p> <p>Check <a class="reference internal" href="general/announcements/index.html#announcements-main"><span class="std std-ref">Announcements</span></a> and check <a class="reference internal" href="release-notes/index.html#latest-neuron-release"><span class="std std-ref">Neuron 2.14.1 (09/26/2023)</span></a> for latest release.</p> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils"> <div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils"> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Get Started with Neuron</div> </div> <a class="sd-stretched-link reference internal" href="general/quick-start/index.html#neuron-quickstart"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Neuron Quick Links</div> </div> <a class="sd-stretched-link reference internal" href="general/quick-start/docs-quicklinks.html#docs-quick-links"><span class="std std-ref"></span></a></div> </div> </div> <div class="toctree-wrapper compound"> <p aria-level="2" class="caption" role="heading"><span class="caption-text">Overview</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="general/quick-start/docs-quicklinks.html">Quick Links</a></li> <li class="toctree-l1"><a class="reference internal" href="general/quick-start/index.html">Get Started with Neuron</a></li> <li class="toctree-l1"><a class="reference internal" href="general/quick-start/github-samples.html">GitHub Samples</a></li> <li class="toctree-l1"><a class="reference internal" href="general/benchmarks/index.html">Performance</a></li> <li class="toctree-l1"><a class="reference internal" href="release-notes/index.html">What’s New</a></li> <li class="toctree-l1"><a class="reference internal" href="general/announcements/index.html">Announcements</a></li> </ul> </div> <div class="toctree-wrapper compound"> <p aria-level="2" class="caption" role="heading"><span class="caption-text">ML Frameworks</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="frameworks/torch/index.html">PyTorch Neuron</a></li> <li class="toctree-l1"><a class="reference internal" href="frameworks/tensorflow/index.html">TensorFlow Neuron</a></li> <li class="toctree-l1"><a class="reference internal" href="frameworks/mxnet-neuron/index.html">Apache MXNet (Incubating)</a></li> </ul> </div> <div class="toctree-wrapper compound"> <p aria-level="2" class="caption" role="heading"><span class="caption-text">ML Libraries</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="libraries/transformers-neuronx/index.html">Transformers Neuron</a></li> <li class="toctree-l1"><a class="reference internal" href="libraries/neuronx-distributed/index.html">Neuron Distributed</a></li> <li class="toctree-l1"><a class="reference internal" href="libraries/nemo-megatron/index.html">AWS Neuron Reference for NeMo Megatron</a></li> </ul> </div> <div class="toctree-wrapper compound"> <p aria-level="2" class="caption" role="heading"><span class="caption-text">User Guide</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="neuron-runtime/index.html">Neuron Runtime</a></li> <li class="toctree-l1"><a class="reference internal" href="compiler/index.html">Neuron Compiler</a></li> <li class="toctree-l1"><a class="reference internal" href="neuron-customops/index.html">Neuron C++ Custom Operators</a></li> <li class="toctree-l1"><a class="reference internal" href="tools/index.html">Neuron Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="general/calculator/neuron-calculator.html">Neuron Calculator</a></li> <li class="toctree-l1"><a class="reference internal" href="general/setup/index.html">Setup Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="containers/index.html">Containers Deployment</a></li> <li class="toctree-l1"><a class="reference internal" href="general/devflows/index.html">Developer Flows</a></li> </ul> </div> <div class="toctree-wrapper compound"> <p aria-level="2" class="caption" role="heading"><span class="caption-text">Learning Neuron</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="general/arch/index.html">Architecture</a></li> <li class="toctree-l1"><a class="reference internal" href="general/arch/neuron-features/index.html">Features</a></li> <li class="toctree-l1"><a class="reference internal" href="general/appnotes/index.html">Application Notes</a></li> <li class="toctree-l1"><a class="reference internal" href="general/faq.html">FAQ</a></li> <li class="toctree-l1"><a class="reference internal" href="general/troubleshooting.html">Troubleshooting</a></li> </ul> </div> <div class="toctree-wrapper compound"> <p aria-level="2" class="caption" role="heading"><span class="caption-text">About Neuron</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="release-notes/release.html">Release Details</a></li> <li class="toctree-l1"><a class="reference internal" href="general/roadmap-readme.html">Roadmap</a></li> <li class="toctree-l1"><a class="reference internal" href="general/support.html">Support</a></li> </ul> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="right-next" id="next-link" href="general/quick-start/docs-quicklinks.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Neuron Quick Links</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:36.563Z
Neuron Quick Links — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/general/quick-start/docs-quicklinks.html
# Neuron Quick Links — AWS Neuron Documentation Toggle in-page Table of Contents
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Neuron Quick Links — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Get Started with Neuron" href="index.html"> <link rel="prev" title="Welcome to AWS Neuron" href="../../index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "general/quick-start/docs-quicklinks", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active"> <a class="current reference internal" href="#"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fgeneral/quick-start/docs-quicklinks.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/general/quick-start/docs-quicklinks.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/general/quick-start/docs-quicklinks.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Neuron Quick Links</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="neuron-quick-links"> <span id="docs-quick-links"></span><h1>Neuron Quick Links<a class="headerlink" href="#neuron-quick-links" title="Permalink to this headline">#</a></h1> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils"> <div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils"> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Overview<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="index.html#neuron-quickstart"><span class="std std-ref">Get Started with Neuron</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="github-samples.html#neuron-github-samples"><span class="std std-ref">Neuron GitHub Samples</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../benchmarks/index.html#benchmark"><span class="std std-ref">Neuron Performance</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/index.html#neuron-whatsnew"><span class="std std-ref">What’s New</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../announcements/index.html#announcements-main"><span class="std std-ref">Announcements</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> ML Frameworks<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../frameworks/torch/index.html#pytorch-neuronx-main"><span class="std std-ref">PyTorch Neuron</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../frameworks/tensorflow/index.html#tensorflow-neuron-main"><span class="std std-ref">TensorFlow Neuron</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../frameworks/mxnet-neuron/index.html#mxnet-neuron-main"><span class="std std-ref">MXNet Neuron</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> ML Libraries<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../libraries/transformers-neuronx/index.html#transformers-neuronx-readme"><span class="std std-ref">Transformers Neuron (transformers-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../libraries/neuronx-distributed/index.html#neuronx-distributed-index"><span class="std std-ref">Neuron Distributed</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> User Guide<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../neuron-runtime/index.html#neuron-runtime"><span class="std std-ref">Neuron Runtime</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../compiler/index.html#neuron-cc"><span class="std std-ref">Neuron Compiler</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../neuron-customops/index.html#neuron-c-customops"><span class="std std-ref">Neuron Custom C++ Operators [Experimental]</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../tools/index.html#neuron-tools"><span class="std std-ref">Neuron Tools</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../setup/index.html#setup-guide-index"><span class="std std-ref">Setup Guide</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../containers/index.html#neuron-containers"><span class="std std-ref">Deploy Containers with Neuron</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../devflows/index.html#neuron-devflows"><span class="std std-ref">Developer Flows</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Learn Neuron<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../arch/index.html#neuron-architecture-index"><span class="std std-ref">Neuron Architecture</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../arch/neuron-features/index.html#neuron-features-index"><span class="std std-ref">Neuron Features</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../appnotes/index.html#neuron-appnotes-index"><span class="std std-ref">Neuron Application Notes</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../faq.html#neuron-faq"><span class="std std-ref">Neuron FAQ</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../troubleshooting.html#general-troubleshooting"><span class="std std-ref">Troubleshooting Guide</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> About Neuron<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/release.html#latest-release"><span class="std std-ref">Release Details</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../roadmap-readme.html#neuron-roadmap"><span class="std std-ref">Roadmap</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../support.html#neuron-support"><span class="std std-ref">Support</span></a></p></li> </ul> </div> </details></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Welcome to AWS Neuron</p> </div> </a> <a class="right-next" id="next-link" href="index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Get Started with Neuron</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:38.158Z
Get Started with Neuron — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/general/quick-start/index.html
# Get Started with Neuron — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` ## Get Started with Neuron[#](#get-started-with-neuron "Permalink to this headline") This section walks you through the various options to get started with Neuron. You have to install Neuron on Trainium and Inferentia powered instances to enable deep-learning acceleration. Get Started with TensorFlow _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Get Started with Neuron — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Neuron GitHub Samples" href="github-samples.html"> <link rel="prev" title="Neuron Quick Links" href="docs-quicklinks.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "general/quick-start/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1 current active"> <a class="current reference internal" href="#"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fgeneral/quick-start/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/general/quick-start/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/general/quick-start/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Get Started with Neuron</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="get-started-with-neuron"> <span id="neuron-quickstart"></span><h1>Get Started with Neuron<a class="headerlink" href="#get-started-with-neuron" title="Permalink to this headline">#</a></h1> <p>This section walks you through the various options to get started with Neuron. You have to install Neuron on Trainium and Inferentia powered instances to enable deep-learning acceleration.</p> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Get Started with PyTorch</div> </div> <a class="sd-stretched-link reference internal" href="../../frameworks/torch/index.html#pytorch-neuronx-main"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Get Started with TensorFlow</div> </div> <a class="sd-stretched-link reference internal" href="../../frameworks/tensorflow/index.html#tensorflow-neuron-main"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Get Started with MXNet</div> </div> <a class="sd-stretched-link reference internal" href="../../frameworks/mxnet-neuron/index.html#mxnet-neuron-main"><span class="std std-ref"></span></a></div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="docs-quicklinks.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Neuron Quick Links</p> </div> </a> <a class="right-next" id="next-link" href="github-samples.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Neuron GitHub Samples</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:38.296Z
Neuron GitHub Samples — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/general/quick-start/github-samples.html
# Neuron GitHub Samples — AWS Neuron Documentation Toggle in-page Table of Contents
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Neuron GitHub Samples — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Neuron Performance" href="../benchmarks/index.html"> <link rel="prev" title="Get Started with Neuron" href="index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "general/quick-start/github-samples", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1 current active"> <a class="current reference internal" href="#"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fgeneral/quick-start/github-samples.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/general/quick-start/github-samples.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/general/quick-start/github-samples.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Neuron GitHub Samples</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="neuron-github-samples"> <span id="id1"></span><h1>Neuron GitHub Samples<a class="headerlink" href="#neuron-github-samples" title="Permalink to this headline">#</a></h1> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils"> <div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils"> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Training Samples for <code class="docutils literal notranslate"><span class="pre">Trn1</span></code><div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx#training">PyTorch Neuron (torch-neuronx) samples for Trn1</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron">Nemo Megatron for Neuron for Trn1</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples">AWS Neuron samples for ParallelCluster</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples">AWS Neuron samples for EKS</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples">AWS Neuron samples for SageMaker</a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Inference Samples for <code class="docutils literal notranslate"><span class="pre">Inf2</span> <span class="pre">&amp;</span> <span class="pre">Trn1</span></code><div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx#inference">PyTorch Neuron (torch-neuronx) samples for Inf2 &amp; Trn1</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx">Transformers Neuron (transformers-neuronx) samples</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples">AWS Neuron samples for SageMaker</a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Inference Samples for <code class="docutils literal notranslate"><span class="pre">Inf1</span></code><div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron">PyTorch Neuron (torch-neuron) samples for Inf1</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron">TensorFlow Neuron (tensorflow-neuron) samples for Inf1</a></p></li> </ul> </div> </details></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Get Started with Neuron</p> </div> </a> <a class="right-next" id="next-link" href="../benchmarks/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Neuron Performance</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:39.752Z
Neuron Performance — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/general/benchmarks/index.html
# Neuron Performance — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` ## Neuron Performance[#](#neuron-performance "Permalink to this headline") The Neuron Performance pages provide a reference to the expected performance of various open-source models for popular deep learning in Natural Language Processing (NLP), Computer Vision (CV) and Recommender model tasks. We have included with each model links to allow you to setup and reconstruct the test with a few steps. Trn1/Trn1n Performance Numbers _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Neuron Performance — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="What’s New" href="../../release-notes/index.html"> <link rel="prev" title="Neuron GitHub Samples" href="../quick-start/github-samples.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "general/benchmarks/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1 current active"> <a class="current reference internal" href="#"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fgeneral/benchmarks/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/general/benchmarks/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/general/benchmarks/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Neuron Performance</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="neuron-performance"> <span id="benchmark"></span><h1>Neuron Performance<a class="headerlink" href="#neuron-performance" title="Permalink to this headline">#</a></h1> <p>The Neuron Performance pages provide a reference to the expected performance of various open-source models for popular deep learning in Natural Language Processing (NLP), Computer Vision (CV) and Recommender model tasks. We have included with each model links to allow you to setup and reconstruct the test with a few steps.</p> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Inf1 Performance Numbers</div> </div> <a class="sd-stretched-link reference internal" href="inf1/index.html#appnote-performance-benchmark"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Inf2 Performance Numbers</div> </div> <a class="sd-stretched-link reference internal" href="inf2/inf2-performance.html#inf2-performance"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Trn1/Trn1n Performance Numbers</div> </div> <a class="sd-stretched-link reference internal" href="trn1/trn1-performance.html#trn1-performance"><span class="std std-ref"></span></a></div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../quick-start/github-samples.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Neuron GitHub Samples</p> </div> </a> <a class="right-next" id="next-link" href="../../release-notes/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">What’s New</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:39.829Z
All Posts — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/general/announcements/index.html
# All Posts — AWS Neuron Documentation ## [Announcing end of support for torch-neuron version 1.9](neuron2.x/announce-eos-pytorch-1-9.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` Title underline too short. [_Read more ..._](neuron2.x/announce-eos-pytorch-1-9.html) --- ## [Announcing end of support for AWS Neuron reference for Megatron-LM](neuron2.x/announce-eol-megatron-lm.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` [Neuron release 2.12](../../release-notes/prev/rn.html#neuron-2-12-0-whatsnew) will be the last release that will include support for [AWS Neuron reference for Megatron-LM](https://github.com/aws-neuron/aws-neuron-reference-for-megatron-lm). Future releases will not include Neuron support for Megatron-LM. [_Read more ..._](neuron2.x/announce-eol-megatron-lm.html) --- ## [AWS Deep Learning AMIs now available with Neuron 2.12 version](neuron2.x/dlami-neuron-2.12.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` We are happy to announce that the following Deep Learning AMIs are now available with latest Neuron Version 2.12. [_Read more ..._](neuron2.x/dlami-neuron-2.12.html) --- ## [Announcing end of support for Python 3.7](neuron2.x/announce-eol-python-3-7.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` Title underline too short. [_Read more ..._](neuron2.x/announce-eol-python-3-7.html) --- ## [Announcing end of support for Ubuntu 18](neuron2.x/announce-eol-ubuntu-18.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` [Neuron release 2.12](../../release-notes/prev/rn.html#neuron-2-12-0-whatsnew) will be the last release that will include support for `Ubuntu 18` . Future Neuron releases will not include support for `Ubuntu 18` [_Read more ..._](neuron2.x/announce-eol-ubuntu-18.html) --- ## [AWS Deep Learning AMIs now available with Neuron 2.10 version](neuron2.x/dlami-neuron-2.10.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` We are happy to announce that the following Deep Learning AMIs are now available with latest Neuron Version 2.10. These DLAMIs now support all the Neuron EC2 instances including Inf1, Inf2, Trn1/Trn1n. [_Read more ..._](neuron2.x/dlami-neuron-2.10.html) --- ## [Announcing end of support for tensorflow-neuron versions 2.7](neuron1.x/announce-eol-tf-before-2-7.html) _This document is relevant for_: `Inf1` [Neuron release 2.10](../../release-notes/prev/rn.html#neuron-2-10-0-whatsnew) will be the last release that will include `tensorflow-neuron` versions 2.7. Future Neuron releases will not include `tensorflow-neuron` versions 2.7 [_Read more ..._](neuron1.x/announce-eol-tf-before-2-7.html) --- ## [Announcing end of support for mxnet-neuron versions 1.5](neuron1.x/announce-eol-mx-before-1-5.html) _This document is relevant for_: `Inf1` [Neuron release 2.10](../../release-notes/prev/rn.html#neuron-2-10-0-whatsnew) will be the last release that will include `mxnet-neuron` versions 1.5. Future Neuron releases will not include `mxnet-neuron` versions 1.5 [_Read more ..._](neuron1.x/announce-eol-mx-before-1-5.html) --- ## [PyTorch 1.13 Deep Learning Container for Inf2 & Trn1/Trn1n now available for SageMaker](neuron2.x/sm-training-dlc-2.9.1.html) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` We are happy to announce that an updated Deep Learning Container that supports PyTorch 1.13 and Neuron 2.9.1 versions is now available for Sagemaker Training. [_Read more ..._](neuron2.x/sm-training-dlc-2.9.1.html) --- ## [Introducing Neuron packaging and installation changes for Inf1 customers](neuron2.x/neuron250-packages-changes.html) - 22 November 2022 - [en](index/language/en.html) - [neuron2.x](index/tag/neuron2x.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` Starting with [Neuron release 2.5](../../release-notes/prev/rn.html#neuron-2-5-0-whatsnew), Neuron introduces changes in Neuron packages and installation instructions for Inf1, the following Neuron packages will change names: [_Read more ..._](neuron2.x/neuron250-packages-changes.html) --- ## [Announcing end of support for tensorflow-neuron versions 2.5 and 2.6](neuron1.x/announce-eol-tf-before-2-5.html) _This document is relevant for_: `Inf1` [Neuron release 2.5](../../release-notes/prev/rn.html#neuron-2-5-0-whatsnew) will be the last release that will include `tensorflow-neuron` versions 2.5 and 2.6. Future Neuron releases will not include `tensorflow-neuron` versions 2.5 and 2.6. [_Read more ..._](neuron1.x/announce-eol-tf-before-2-5.html) --- ## [Announcing end of support for torch-neuron versions 1.7 and 1.8](neuron1.x/announce-eol-pt-before-1-8.html) _This document is relevant for_: `Inf1` [Neuron release 2.5](../../release-notes/prev/rn.html#neuron-2-5-0-whatsnew) will be the last release that will include `torch-neuron` versions 1.7 and 1.8. Future Neuron releases will not include `torch-neuron` versions 1.7 and 1.8. [_Read more ..._](neuron1.x/announce-eol-pt-before-1-8.html) --- ## [Neuron GPG key for Ubuntu installation has expired](neuron2.x/gpg-expiration.html) - 10 November 2022 - [en](index/language/en.html) - [pytorch](index/tag/pytorch.html) [dlami](index/tag/dlami.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` GPG, or GNU Privacy Guard, is a public key cryptography implementation. This allows for the secure transmission of information between parties and can be used to verify that the origin of a message is genuine. [_Read more ..._](neuron2.x/gpg-expiration.html) --- ## [Amazon SageMaker now supports Trn1 training jobs](neuron2.x/sm-training-trn1-introduce.html) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` We are happy to announce that Amazon SageMaker now supports running training jobs on ml.trn1 instance types. [_Read more ..._](neuron2.x/sm-training-trn1-introduce.html) --- ## [Introducing AWS Deep Learning AMI Neuron PyTorch](neuron2.x/dlami-pytorch-introduce.html) - 02 November 2022 - [en](index/language/en.html) - [pytorch](index/tag/pytorch.html) [dlami](index/tag/dlami.html) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` We are happy to announce that Deep Learning AMI (DLAMI) with pre-installed PyTorch Neuron (`torch-neuronx`) is now available, for more information see: [_Read more ..._](neuron2.x/dlami-pytorch-introduce.html) --- ## [Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA)](neuron2.x/neuron2-intro.html) - 10 October 2022 - [en](index/language/en.html) - [neuron2.x](index/tag/neuron2x.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` Neuron release 2.3 is the first release of Neuron 2.x, and which enables GA of the new EC2 Trn1 instances. Neuron release 2.3 extends latest release of Neuron 1.x (Neuron 1.19.2) to add support for deep-learning training on the AWS Trainium chips. [_Read more ..._](neuron2.x/neuron2-intro.html) --- ## [Introducing Packaging and installation changes](neuron2.x/neuron230-packages-changes.html) - 10 October 2022 - [en](index/language/en.html) - [neuron2.x](index/tag/neuron2x.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` Starting with Neuron release 2.3, Neuron introduces changes in Neuron packages and installation instructions. [_Read more ..._](neuron2.x/neuron230-packages-changes.html) --- ## [Introducing New Neuron GitHub Repositories](neuron2.x/github-changes.html) - 10 October 2022 - [en](index/language/en.html) - [github](index/tag/github.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` Starting with Neuron release 2.3, Neuron Github repositories will be migrated to the new [AWS Neuron GitHub Organization](https://github.com/aws-neuron). [_Read more ..._](neuron2.x/github-changes.html) --- ## [Announcing Neuron Runtime 1.x (neuron-rtd) end-of-support](neuron2.x/neuron-rtd-eol.html) - 10 October 2022 - [en](index/language/en.html) - [eol](index/tag/eol.html) [neuron2.x](index/tag/neuron2x.html) _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` Starting with Neuron release 2.3, Neuron components like Neuron System Tools and Neuron Driver will no longer support Neuron Runtime 1.x. [_Read more ..._](neuron2.x/neuron-rtd-eol.html) --- ## [End of support for torch-neuron version 1.5](neuron1.x/eol-pt-15.html) - 29 April 2022 - [en](index/language/en.html) - [eol](index/tag/eol.html) _This document is relevant for_: `Inf1` Starting with _Neuron 1.19.0_ release, _torch-neuron 1.5_ will no longer be supported, and no further releases of _torch-neuron version 1.5_ will be issued. Current users of torch-neuron version 1.5 are advised to migrate to latest _torch-neuron_ version. [_Read more ..._](neuron1.x/eol-pt-15.html) --- ## [End of support for tensorflow-neuron versions 2.1, 2.2, 2.3 and 2.4](neuron1.x/eol-tf-21-24.html) - 25 March 2022 - [en](index/language/en.html) - [eol](index/tag/eol.html) _This document is relevant for_: `Inf1` Starting with _Neuron 1.18.0_ release, _tensorflow-neuron versions 2.1, 2.2, 2.3 and 2.4_ will no longer be supported, and no further releases of _tensorflow-neuron versions 2.1, 2.2, 2.3 and 2.4_ will be issued. Current users of those versions are advised to migrate to latest _tensorflow-neuron_ version. [_Read more ..._](neuron1.x/eol-tf-21-24.html) --- ## [Announcing end of support for torch-neuron version 1.5 starting with Neuron 1.19.0 release](neuron1.x/announce-eol-pt-1-5.html) _This document is relevant for_: `Inf1` Starting with _Neuron 1.19.0_ release, _torch-neuron version 1.5_ will no longer be supported. Last release of _torch-neuron version 1.5_ will be issued as part of _Neuron 1.18.0_ release. Current users of those versions are advised to migrate to latest _torch-neuron_ version. [_Read more ..._](neuron1.x/announce-eol-pt-1-5.html) --- ## [Announcing end of support for NEURONCORE\_GROUP\_SIZES starting with Neuron 1.20.0 release](neuron1.x/eol-ncgs-env_2.html) - 25 March 2022 - [en](index/language/en.html) - [announce-eol](index/tag/announce-eol.html) _This document is relevant for_: `Inf1` Starting with Neuron SDK 1.20.0, `NEURONCORE_GROUP_SIZES` environment variable will no longer be supported. Setting `NEURONCORE_GROUP_SIZES` environment variable will no longer affect applications behavior. Current customers using `NEURONCORE_GROUP_SIZES` environment variable are advised to use `NEURON_RT_VISIBLE_CORES` environment variable or `NEURON_RT_NUM_CORES` environment variable instead. [_Read more ..._](neuron1.x/eol-ncgs-env_2.html) --- ## [Previous Announcements](neuron1.x/announcements.html) - 17 February 2022 - [en](index/language/en.html) - [announcements](index/tag/announcements.html) _This document is relevant for_: `Inf1` [02/17/2022 - tensorflow-neuron versions 2.1, 2.2, 2.3 and 2.4 enter maintenance mode](#tensorflow-neuron-versions-2-1-2-2-2-3-and-2-4-enter-maintenance-mode) [_Read more ..._](neuron1.x/announcements.html) ---
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>All Posts — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <link rel="alternate" type="application/atom+xml" href="index/atom.xml" title=""> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "general/announcements/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"> <h3> <a href="#">Recent Posts</a> </h3> <ul> <li> <a href="neuron2.x/announce-deprecation-transformer-flag.html">Announcing deprecation for --model-type=transformer-inference compiler flag</a> </li> <li> <a href="neuron2.x/announce-eos-pytorch-1-9.html">Announcing end of support for torch-neuron version 1.9</a> </li> <li> <a href="neuron2.x/announce-eos-megatronlm-2-13.html">AWS Neuron reference for Megatron-LM no longer supported</a> </li> <li> <a href="neuron2.x/announce-eol-megatron-lm.html">Announcing end of support for AWS Neuron reference for Megatron-LM</a> </li> <li> <a href="neuron2.x/dlami-neuron-2.12.html">AWS Deep Learning AMIs now available with Neuron 2.12 version</a> </li> <li> <a href="neuron2.x/announce-eol-python-3-7.html">Announcing end of support for Python 3.7</a> </li> <li> <a href="neuron2.x/announce-eol-ubuntu-18.html">Announcing end of support for Ubuntu 18</a> </li> <li> <a href="neuron2.x/dlami-neuron-2.10.html">AWS Deep Learning AMIs now available with Neuron 2.10 version</a> </li> <li> <a href="neuron1.x/announce-eol-tf-before-2-7.html">Announcing end of support for tensorflow-neuron versions 2.7</a> </li> <li> <a href="neuron1.x/announce-eol-mx-before-1-5.html">Announcing end of support for mxnet-neuron versions 1.5</a> </li> </ul> </div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fgeneral/announcements/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Announcements</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <div class="section"> <h1> All Posts </h1> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/announce-deprecation-transformer-flag.html">Announcing deprecation for --model-type=transformer-inference compiler flag</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 15 September 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/announce-deprecation.html">announce-deprecation</a> <a href="index/tag/transformer-flag.html">transformer-flag</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>Title underline too short.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/announce-deprecation-transformer-flag.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/announce-eos-pytorch-1-9.html">Announcing end of support for torch-neuron version 1.9</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 28 August 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/announce-eol.html">announce-eol</a> <a href="index/tag/torch-neuron.html">torch-neuron</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>Title underline too short.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/announce-eos-pytorch-1-9.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/announce-eos-megatronlm-2-13.html">AWS Neuron reference for Megatron-LM no longer supported</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 28 August 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/trn1n.html">trn1n</a> <a href="index/tag/announce-eos.html">announce-eos</a> <a href="index/tag/trn1.html">trn1</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p><a class="reference internal" href="../../release-notes/prev/rn.html#neuron-2-13-0-whatsnew"><span class="std std-ref">Neuron release 2.13</span></a> no longer includes support for <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-reference-for-megatron-lm">AWS Neuron reference for Megatron-LM</a>.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/announce-eos-megatronlm-2-13.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/announce-eol-megatron-lm.html">Announcing end of support for AWS Neuron reference for Megatron-LM</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 08 August 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/announce-eol.html">announce-eol</a> <a href="index/tag/trn1n.html">trn1n</a> <a href="index/tag/trn1.html">trn1</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p><a class="reference internal" href="../../release-notes/prev/rn.html#neuron-2-12-0-whatsnew"><span class="std std-ref">Neuron release 2.12</span></a> will be the last release that will include support for <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-reference-for-megatron-lm">AWS Neuron reference for Megatron-LM</a>. Future releases will not include Neuron support for Megatron-LM.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/announce-eol-megatron-lm.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/dlami-neuron-2.12.html">AWS Deep Learning AMIs now available with Neuron 2.12 version</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 26 July 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/dlami.html">dlami</a> <a href="index/tag/inf2.html">inf2</a> <a href="index/tag/pytorch.html">pytorch</a> <a href="index/tag/trn1.html">trn1</a> <a href="index/tag/inf1.html">inf1</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>We are happy to announce that the following Deep Learning AMIs are now available with latest Neuron Version 2.12.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/dlami-neuron-2.12.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/announce-eol-python-3-7.html">Announcing end of support for Python 3.7</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 26 July 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/announce-eol.html">announce-eol</a> <a href="index/tag/python37.html">python37</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>Title underline too short.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/announce-eol-python-3-7.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/announce-eol-ubuntu-18.html">Announcing end of support for Ubuntu 18</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 13 July 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/announce-eol.html">announce-eol</a> <a href="index/tag/ubuntu18.html">ubuntu18</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p><a class="reference internal" href="../../release-notes/prev/rn.html#neuron-2-12-0-whatsnew"><span class="std std-ref">Neuron release 2.12</span></a> will be the last release that will include support for <code class="docutils literal notranslate"><span class="pre">Ubuntu</span> <span class="pre">18</span></code> . Future Neuron releases will not include support for <code class="docutils literal notranslate"><span class="pre">Ubuntu</span> <span class="pre">18</span></code></p> </div> <p class="ablog-post-expand"><a href="neuron2.x/announce-eol-ubuntu-18.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/dlami-neuron-2.10.html">AWS Deep Learning AMIs now available with Neuron 2.10 version</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 02 May 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/dlami.html">dlami</a> <a href="index/tag/inf2.html">inf2</a> <a href="index/tag/pytorch.html">pytorch</a> <a href="index/tag/trn1.html">trn1</a> <a href="index/tag/inf1.html">inf1</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>We are happy to announce that the following Deep Learning AMIs are now available with latest Neuron Version 2.10. These DLAMIs now support all the Neuron EC2 instances including Inf1, Inf2, Trn1/Trn1n.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/dlami-neuron-2.10.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron1.x/announce-eol-tf-before-2-7.html">Announcing end of support for tensorflow-neuron versions 2.7</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 01 May 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/announce-eol-tensorflow-neuron.html">announce-eol tensorflow-neuron</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <p><a class="reference internal" href="../../release-notes/prev/rn.html#neuron-2-10-0-whatsnew"><span class="std std-ref">Neuron release 2.10</span></a> will be the last release that will include <code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code> versions 2.7. Future Neuron releases will not include <code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code> versions 2.7</p> </div> <p class="ablog-post-expand"><a href="neuron1.x/announce-eol-tf-before-2-7.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron1.x/announce-eol-mx-before-1-5.html">Announcing end of support for mxnet-neuron versions 1.5</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 01 May 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/announce-eol-mxnet-neuron.html">announce-eol mxnet-neuron</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <p><a class="reference internal" href="../../release-notes/prev/rn.html#neuron-2-10-0-whatsnew"><span class="std std-ref">Neuron release 2.10</span></a> will be the last release that will include <code class="docutils literal notranslate"><span class="pre">mxnet-neuron</span></code> versions 1.5. Future Neuron releases will not include <code class="docutils literal notranslate"><span class="pre">mxnet-neuron</span></code> versions 1.5</p> </div> <p class="ablog-post-expand"><a href="neuron1.x/announce-eol-mx-before-1-5.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/sm-training-dlc-2.9.1.html">PyTorch 1.13 Deep Learning Container for Inf2 &amp; Trn1/Trn1n now available for SageMaker</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 26 April 2023 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/sagemaker.html">sagemaker</a> <a href="index/tag/inf2.html">inf2</a> <a href="index/tag/pytorch.html">pytorch</a> <a href="index/tag/trn1.html">trn1</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>We are happy to announce that an updated Deep Learning Container that supports PyTorch 1.13 and Neuron 2.9.1 versions is now available for Sagemaker Training.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/sm-training-dlc-2.9.1.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/neuron250-packages-changes.html">Introducing Neuron packaging and installation changes for Inf1 customers</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 22 November 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/neuron2x.html">neuron2.x</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>Starting with <a class="reference internal" href="../../release-notes/prev/rn.html#neuron-2-5-0-whatsnew"><span class="std std-ref">Neuron release 2.5</span></a>, Neuron introduces changes in Neuron packages and installation instructions for Inf1, the following Neuron packages will change names:</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/neuron250-packages-changes.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron1.x/announce-eol-tf-before-2-5.html">Announcing end of support for tensorflow-neuron versions 2.5 and 2.6</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 22 November 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/announce-eol-tensorflow-neuron.html">announce-eol tensorflow-neuron</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <p><a class="reference internal" href="../../release-notes/prev/rn.html#neuron-2-5-0-whatsnew"><span class="std std-ref">Neuron release 2.5</span></a> will be the last release that will include <code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code> versions 2.5 and 2.6. Future Neuron releases will not include <code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code> versions 2.5 and 2.6.</p> </div> <p class="ablog-post-expand"><a href="neuron1.x/announce-eol-tf-before-2-5.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron1.x/announce-eol-pt-before-1-8.html">Announcing end of support for torch-neuron versions 1.7 and 1.8</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 22 November 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/announce-eol-torch-neuron.html">announce-eol torch-neuron</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <p><a class="reference internal" href="../../release-notes/prev/rn.html#neuron-2-5-0-whatsnew"><span class="std std-ref">Neuron release 2.5</span></a> will be the last release that will include <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> versions 1.7 and 1.8. Future Neuron releases will not include <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> versions 1.7 and 1.8.</p> </div> <p class="ablog-post-expand"><a href="neuron1.x/announce-eol-pt-before-1-8.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/gpg-expiration.html">Neuron GPG key for Ubuntu installation has expired</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 10 November 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/pytorch.html">pytorch</a> <a href="index/tag/dlami.html">dlami</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>GPG, or GNU Privacy Guard, is a public key cryptography implementation. This allows for the secure transmission of information between parties and can be used to verify that the origin of a message is genuine.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/gpg-expiration.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/sm-training-trn1-introduce.html">Amazon SageMaker now supports Trn1 training jobs</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 03 November 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/sagemaker.html">sagemaker</a> <a href="index/tag/pytorch.html">pytorch</a> <a href="index/tag/trn1.html">trn1</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>We are happy to announce that Amazon SageMaker now supports running training jobs on ml.trn1 instance types.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/sm-training-trn1-introduce.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/dlami-pytorch-introduce.html">Introducing AWS Deep Learning AMI Neuron PyTorch</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 02 November 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/pytorch.html">pytorch</a> <a href="index/tag/dlami.html">dlami</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>We are happy to announce that Deep Learning AMI (DLAMI) with pre-installed PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) is now available, for more information see:</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/dlami-pytorch-introduce.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/neuron2-intro.html">Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA)</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 10 October 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/neuron2x.html">neuron2.x</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p><span class="xref std std-ref">Neuron release 2.3</span> is the first release of Neuron 2.x, and which enables GA of the new EC2 Trn1 instances. Neuron release 2.3 extends latest release of Neuron 1.x (Neuron 1.19.2) to add support for deep-learning training on the AWS Trainium chips.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/neuron2-intro.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/neuron230-packages-changes.html">Introducing Packaging and installation changes</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 10 October 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/neuron2x.html">neuron2.x</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>Starting with <span class="xref std std-ref">Neuron release 2.3</span>, Neuron introduces changes in Neuron packages and installation instructions.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/neuron230-packages-changes.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/github-changes.html">Introducing New Neuron GitHub Repositories</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 10 October 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/github.html">github</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>Starting with <span class="xref std std-ref">Neuron release 2.3</span>, Neuron Github repositories will be migrated to the new <a class="reference external" href="https://github.com/aws-neuron">AWS Neuron GitHub Organization</a>.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/github-changes.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron2.x/neuron-rtd-eol.html">Announcing Neuron Runtime 1.x (neuron-rtd) end-of-support</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 10 October 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tags"></i> </span> <a href="index/tag/eol.html">eol</a> <a href="index/tag/neuron2x.html">neuron2.x</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <p>Starting with <span class="xref std std-ref">Neuron release 2.3</span>, Neuron components like Neuron System Tools and Neuron Driver will no longer support Neuron Runtime 1.x.</p> </div> <p class="ablog-post-expand"><a href="neuron2.x/neuron-rtd-eol.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron1.x/eol-pt-15.html">End of support for torch-neuron version 1.5</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 29 April 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/eol.html">eol</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <p>Starting with <em>Neuron 1.19.0</em> release, <em>torch-neuron 1.5</em> will no longer be supported, and no further releases of <em>torch-neuron version 1.5</em> will be issued. Current users of torch-neuron version 1.5 are advised to migrate to latest <em>torch-neuron</em> version.</p> </div> <p class="ablog-post-expand"><a href="neuron1.x/eol-pt-15.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron1.x/eol-tf-21-24.html">End of support for tensorflow-neuron versions 2.1, 2.2, 2.3 and 2.4</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 25 March 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/eol.html">eol</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <p>Starting with <em>Neuron 1.18.0</em> release, <em>tensorflow-neuron versions 2.1, 2.2, 2.3 and 2.4</em> will no longer be supported, and no further releases of <em>tensorflow-neuron versions 2.1, 2.2, 2.3 and 2.4</em> will be issued. Current users of those versions are advised to migrate to latest <em>tensorflow-neuron</em> version.</p> </div> <p class="ablog-post-expand"><a href="neuron1.x/eol-tf-21-24.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron1.x/announce-eol-pt-1-5.html">Announcing end of support for torch-neuron version 1.5 starting with Neuron 1.19.0 release</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 25 March 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/announce-eol-torch-neuron.html">announce-eol torch-neuron</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <p>Starting with <em>Neuron 1.19.0</em> release, <em>torch-neuron version 1.5</em> will no longer be supported. Last release of <em>torch-neuron version 1.5</em> will be issued as part of <em>Neuron 1.18.0</em> release. Current users of those versions are advised to migrate to latest <em>torch-neuron</em> version.</p> </div> <p class="ablog-post-expand"><a href="neuron1.x/announce-eol-pt-1-5.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron1.x/eol-ncgs-env_2.html">Announcing end of support for NEURONCORE_GROUP_SIZES starting with Neuron 1.20.0 release</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 25 March 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/announce-eol.html">announce-eol</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <p>Starting with Neuron SDK 1.20.0, <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> environment variable will no longer be supported. Setting <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> environment variable will no longer affect applications behavior. Current customers using <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> environment variable are advised to use <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code> environment variable or <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code> environment variable instead.</p> </div> <p class="ablog-post-expand"><a href="neuron1.x/eol-ncgs-env_2.html"><em>Read more ...</em></a></p> <hr> </div> <div class="section ablog-post"> <h2 class="ablog-post-title"> <a href="neuron1.x/announcements.html">Previous Announcements</a> </h2> <ul class="ablog-archive"> <li> <i class="fa fa-calendar"></i> 17 February 2022 </li> <li id="language"> <span><i class="fa-fw fa fa-language"></i></span> <a href="index/language/en.html">en</a> </li> <li id="tags"> <span><i class="fa-fw fa fa-tag"></i></span> <a href="index/tag/announcements.html">announcements</a> </li> </ul> <div class="ablog-post-excerpt docutils container"> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <p><a class="reference internal" href="#tensorflow-neuron-versions-2-1-2-2-2-3-and-2-4-enter-maintenance-mode" id="id1">02/17/2022 - tensorflow-neuron versions 2.1, 2.2, 2.3 and 2.4 enter maintenance mode</a></p> </div> <p class="ablog-post-expand"><a href="neuron1.x/announcements.html"><em>Read more ...</em></a></p> <hr> </div> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:41.092Z
What’s New — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/release-notes/index.html
# What’s New — AWS Neuron Documentation _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` ## What’s New[#](#what-s-new "Permalink to this headline") Table of contents - [Neuron 2.14.1 (09/26/2023)](#neuron-2-14-1-09-26-2023) - [Neuron 2.14.0 (09/15/2023)](#neuron-2-14-0-09-15-2023) - [Previous Releases](#previous-releases) ## [Neuron 2.14.1 (09/26/2023)](#id5)[#](#neuron-2-14-1-09-26-2023 "Permalink to this headline") This is a patch release that fixes compiler issues in certain configurations of `Llama` and `Llama-2` model inference using `transformers-neuronx`. ## [Neuron 2.14.0 (09/15/2023)](#id6)[#](#neuron-2-14-0-09-15-2023 "Permalink to this headline") Table of contents - [What’s New](#id2) - [Neuron Components Release Notes](#neuron-components-release-notes) - [Inf1, Trn1/Trn1n and Inf2 common packages](#inf1-trn1-trn1n-and-inf2-common-packages) - [Trn1/Trn1n and Inf2 only packages](#trn1-trn1n-and-inf2-only-packages) - [Inf1 only packages](#inf1-only-packages) - [Release Artifacts](#release-artifacts) ### [What’s New](#id8)[#](#id2 "Permalink to this headline") This release introduces support for `Llama-2-7B` model training and `T5-3B` model inference using `neuronx-distributed`. It also adds support for `Llama-2-13B` model training using `neuronx-nemo-megatron`. Neuron 2.14 also adds support for `Stable Diffusion XL(Refiner and Base)` model inference using `torch-neuronx` . This release also introduces other new features, performance optimizations, minor enhancements and bug fixes. This release introduces the following: Note This release deprecates `--model-type=transformer-inference` compiler flag. Users are highly encouraged to migrate to the `--model-type=transformer` compiler flag. | What’s New | Details | Instances | | --- | --- | --- | | AWS Neuron Reference for Nemo Megatron library (`neuronx-nemo-megatron`) | - `Llama-2-13B` model training support ( [tutorial](https://github.com/aws-neuron/aws-neuron-parallelcluster-samples/blob/master/examples/jobs/neuronx-nemo-megatron-llamav2-job.md) ) - ZeRO-1 Optimizer support that works with tensor parallelism and pipeline parallelism - See more at [AWS Neuron Reference for Nemo Megatron(neuronx-nemo-megatron) Release Notes](nemo/neuronx-nemo.html#neuronx-nemo-rn) and [neuronx-nemo-megatron github repo](https://github.com/aws-neuron/neuronx-nemo-megatron) | Trn1/Trn1n | | Neuron Distributed (neuronx-distributed) for Training | - `pad_model` API to pad attention heads that do not divide by the number of NeuronCores, this will allow users to use any supported tensor-parallel degree. See [API Reference Guide (neuronx-distributed )](../libraries/neuronx-distributed/api_guide.html#api-guide) - `Llama-2-7B` model training support ([sample script](https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training/tp_zero1_llama2_7b_hf_pretrain)) ([tutorial](../libraries/neuronx-distributed/tutorials/training_llama2_7b.html#llama2-7b-tp-zero1-tutorial)) - See more at [Neuron Distributed Release Notes (neuronx-distributed)](neuronx-distributed/neuronx-distributed.html#neuronx-distributed-rn) and [API Reference Guide (neuronx-distributed )](../libraries/neuronx-distributed/api_guide.html#api-guide) | Trn1/Trn1n | | Neuron Distributed (neuronx-distributed) for Inference | - `T5-3B` model inference support ([tutorial](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.ipynb)) - `pad_model` API to pad attention heads that do not divide by the number of NeuronCores, this will allow users to use any supported tensor-parallel degree. See [API Reference Guide (neuronx-distributed )](../libraries/neuronx-distributed/api_guide.html#api-guide) - See more at [Neuron Distributed Release Notes (neuronx-distributed)](neuronx-distributed/neuronx-distributed.html#neuronx-distributed-rn) and [API Reference Guide (neuronx-distributed )](../libraries/neuronx-distributed/api_guide.html#api-guide) | Inf2,Trn1/Trn1n | | Transformers Neuron (transformers-neuronx) for Inference | - Introducing `--model-type=transformer` compiler flag that deprecates `--model-type=transformer-inference` compiler flag. - See more at [Transformers Neuron (transformers-neuronx) release notes](torch/transformers-neuronx/index.html#transformers-neuronx-rn) | Inf2, Trn1/Trn1n | | PyTorch Neuron (torch-neuronx) | - Performance optimizations in `torch_neuronx.analyze` API. See [PyTorch Neuron (torch-neuronx) Analyze API for Inference](../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html#torch-neuronx-analyze-api) - `Stable Diffusion XL(Refiner and Base)` model inference support ( [sample script](https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/inference/hf_pretrained_sdxl_base_and_refiner_1024_inference.ipynb)) | Trn1/Trn1n,Inf2 | | Neuron Compiler (neuronx-cc) | - New `--optlevel``(or ``-O`) compiler option that enables different optimizations with tradeoff between faster model compile time and faster model execution. See more at [Neuron Compiler CLI Reference Guide (neuronx-cc)](../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) - See more at [Neuron Compiler (neuronx-cc) release notes](compiler/neuronx-cc/index.html#neuronx-cc-rn) | Inf2/Trn1/Trn1n | | Neuron Tools | - Neuron SysFS support for showing connected devices on `trn1.32xl`, `inf2.24xl` and `inf2.48xl` instances. See [Neuron Sysfs User Guide](../tools/neuron-sys-tools/neuron-sysfs-user-guide.html#neuron-sysfs-ug) - See more at [Neuron System Tools](tools/aws-neuronx-tools.html#neuron-tools-rn) | Inf1/Inf2/Trn1/Trn1n | | Documentation Updates | - Neuron Calculator now supports multiple model configurations for Tensor Parallel Degree computation. See [Neuron Calculator](../general/calculator/neuron-calculator.html#neuron-calculator) - Announcement to deprecate `--model-type=transformer-inference` flag. See [Announcing deprecation for --model-type=transformer-inference compiler flag](../general/announcements/neuron2.x/announce-deprecation-transformer-flag.html#announce-deprecation-transformer-flag) - See more at [Neuron Documentation Release Notes](documentation/neuron-documentation.html#neuron-documentation-rn) | Inf1, Inf2, Trn1/Trn1n | | Minor enhancements and bug fixes. | - See [Neuron Components Release Notes](#components-rn) | Trn1/Trn1n , Inf2, Inf1 | | Release Artifacts | - see [Release Artifacts](#latest-neuron-release-artifacts) | Trn1/Trn1n , Inf2, Inf1 | For more detailed release notes of the new features and resolved issues, see [Neuron Components Release Notes](#components-rn). To learn about the model architectures currently supported on Inf1, Inf2, Trn1 and Trn1n instances, please see [Model Architecture Fit Guidelines](../general/arch/model-architecture-fit.html#model-architecture-fit). ### [Neuron Components Release Notes](#id9)[#](#neuron-components-release-notes "Permalink to this headline") #### [Inf1, Trn1/Trn1n and Inf2 common packages](#id10)[#](#inf1-trn1-trn1n-and-inf2-common-packages "Permalink to this headline") | Component | Instance/s | Package/s | Details | | --- | --- | --- | --- | | Neuron Runtime | Trn1/Trn1n, Inf1, Inf2 | - Trn1/Trn1n: `aws-neuronx-runtime-lib` (.deb, .rpm) - Inf1: Runtime is linked into the ML frameworks packages | - [Neuron Runtime Release Notes](runtime/aws-neuronx-runtime-lib/index.html#neuron-runtime-rn) | | Neuron Runtime Driver | Trn1/Trn1n, Inf1, Inf2 | - `aws-neuronx-dkms` (.deb, .rpm) | - [Neuron Driver Release Notes](runtime/aws-neuronx-dkms/index.html#neuron-driver-release-notes) | | Neuron System Tools | Trn1/Trn1n, Inf1, Inf2 | - `aws-neuronx-tools` (.deb, .rpm) | - [Neuron System Tools](tools/aws-neuronx-tools.html#neuron-tools-rn) | | Containers | Trn1/Trn1n, Inf1, Inf2 | - `aws-neuronx-k8-plugin` (.deb, .rpm) - `aws-neuronx-k8-scheduler` (.deb, .rpm) - `aws-neuronx-oci-hooks` (.deb, .rpm) | - [Neuron K8 Release Notes](containers/neuron-k8.html#neuron-k8-rn) - [Neuron Containers Release Notes](containers/neuron-containers.html#neuron-containers-release-notes) | | NeuronPerf (Inference only) | Trn1/Trn1n, Inf1, Inf2 | - `neuronperf` (.whl) | - [NeuronPerf 1.x Release Notes](tools/neuronperf.html#neuronperf-rn) | | TensorFlow Model Server Neuron | Trn1/Trn1n, Inf1, Inf2 | - `tensorflow-model-server-neuronx` (.deb, .rpm) | - [TensorFlow-Model-Server-Neuron (tensorflow-modeslserver-neuronx) Release Notes](tensorflow/tensorflow-modelserver-neuron/tensorflow-modelserver-neuronx.html#tensorflow-modeslserver-neuronx-rn) | | Neuron Documentation | Trn1/Trn1n, Inf1, Inf2 | | - [Neuron Documentation Release Notes](documentation/neuron-documentation.html#neuron-documentation-rn) | #### [Trn1/Trn1n and Inf2 only packages](#id11)[#](#trn1-trn1n-and-inf2-only-packages "Permalink to this headline") | Component | Instance/s | Package/s | Details | | --- | --- | --- | --- | | PyTorch Neuron | Trn1/Trn1n, Inf2 | - `torch-neuronx` (.whl) | - [PyTorch Neuron (torch-neuronx) release notes](torch/torch-neuronx/index.html#torch-neuronx-rn) - [PyTorch Neuron (torch-neuronx) - Supported Operators](../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators) | | TensorFlow Neuron | Trn1/Trn1n, Inf2 | - `tensorflow-neuronx` (.whl) | - [TensorFlow Neuron (tensorflow-neuronx) Release Notes](tensorflow/tensorflow-neuronx/tensorflow-neuronx.html#tensorflow-neuronx-release-notes) | | Neuron Compiler (Trn1/Trn1n, Inf2 only) | Trn1/Trn1n, Inf2 | - `neuronx-cc` (.whl) | - [Neuron Compiler (neuronx-cc) release notes](compiler/neuronx-cc/index.html#neuronx-cc-rn) | | Collective Communication library | Trn1/Trn1n, Inf2 | - `aws-neuronx-collective` (.deb, .rpm) | - [Neuron Collectives Release Notes](runtime/aws-neuronx-collectives/index.html#neuron-collectives-rn) | | Neuron Custom C++ Operators | Trn1/Trn1n, Inf2 | - `aws-neuronx-gpsimd-customop` (.deb, .rpm) - `aws-neuronx-gpsimd-tools` (.deb, .rpm) | - [Neuron Custom C++ Library Release Notes](customcxxps/gpsimd-customop-lib.html#gpsimd-customop-lib-rn) - [Neuron Custom C++ Tools Release Notes](customcxxps/gpsimd-tools.html#gpsimd-customop-tools-rn) | | Transformers Neuron | Trn1/Trn1n, Inf2 | - `transformers-neuronx` (.whl) | - [Transformers Neuron (transformers-neuronx) release notes](torch/transformers-neuronx/index.html#transformers-neuronx-rn) | | Neuron Distributed | Trn1/Trn1n, Inf2 | - `neuronx-distributed` (.whl) | - [Neuron Distributed Release Notes (neuronx-distributed)](neuronx-distributed/neuronx-distributed.html#neuronx-distributed-rn) | | AWS Neuron Reference for NeMo Megatron | Trn1/Trn1n | - [neuronx-nemo-megatron github repo](https://github.com/aws-neuron/neuronx-nemo-megatron) | - [AWS Neuron Reference for Nemo Megatron(neuronx-nemo-megatron) Release Notes](nemo/neuronx-nemo.html#neuronx-nemo-rn) | Note In next releases `aws-neuronx-tools` and `aws-neuronx-runtime-lib` will add support for Inf1. ### [Release Artifacts](#id13)[#](#release-artifacts "Permalink to this headline") Trn1 packages ``` List of packages in Neuron 2.14.1: Component Package Collective Communication Library aws-neuronx-collectives-2.17.9.0 Driver aws-neuronx-dkms-2.13.4.0 nan aws-neuronx-gpsimd-customop-lib-0.7.1.0 CustomOps Tools aws-neuronx-gpsimd-tools-0.7.0.0 General aws-neuronx-runtime-discovery-2.9 Runtime Library aws-neuronx-runtime-lib-2.17.7.0 System Tools aws-neuronx-tools-2.14.6.0 General libneuronxla-0.5.476 General neuronx_hwm-2.10.0.5 PyTorch torch_xla-1.13.1+torchneuronb Compiler neuronx-cc-2.10.0.35 Kubernetes Plugin aws-neuronx-k8-plugin-2.17.3.0 Kubernetes Scheduler aws-neuronx-k8-scheduler-2.17.3.0 OCI aws-neuronx-oci-hook-2.2.22.0 TensorFlow tensorflow-neuronx-2.10.1.2.1.0 TensorFlow tensorflow-neuronx-2.7.4.2.1.0 TensorFlow tensorflow-neuronx-2.8.4.2.1.0 TensorFlow tensorflow-neuronx-2.9.3.2.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-1.15.0.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.10.1.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.7.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.8.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.9.3.2.10.1.0 TensorBoard tensorboard-plugin-neuronx-2.5.39.0 PyTorch torch-neuronx-1.13.1.1.11.0 Transformers Neuron transformers-neuronx-0.7.84 Neuron Distributed neuronx_distributed-0.4.0 ``` Inf2 packages ``` List of packages in Neuron 2.14.1: Component Package Collective Communication Library aws-neuronx-collectives-2.17.9.0 Driver aws-neuronx-dkms-2.13.4.0 nan aws-neuronx-gpsimd-customop-lib-0.7.1.0 CustomOps Tools aws-neuronx-gpsimd-tools-0.7.0.0 General aws-neuronx-runtime-discovery-2.9 Runtime Library aws-neuronx-runtime-lib-2.17.7.0 System Tools aws-neuronx-tools-2.14.6.0 General libneuronxla-0.5.476 General neuronx_hwm-2.10.0.5 PyTorch torch_xla-1.13.1+torchneuronb Compiler neuronx-cc-2.10.0.35 Kubernetes Plugin aws-neuronx-k8-plugin-2.17.3.0 Kubernetes Scheduler aws-neuronx-k8-scheduler-2.17.3.0 OCI aws-neuronx-oci-hook-2.2.22.0 TensorFlow tensorflow-neuronx-2.10.1.2.1.0 TensorFlow tensorflow-neuronx-2.8.4.2.1.0 TensorFlow tensorflow-neuronx-2.9.3.2.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-1.15.0.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.10.1.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.7.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.8.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.9.3.2.10.1.0 TensorBoard tensorboard-plugin-neuronx-2.5.39.0 PyTorch torch-neuronx-1.13.1.1.11.0 Transformers Neuron transformers-neuronx-0.7.84 Neuron Distributed neuronx_distributed-0.4.0 ``` Inf1 packages ``` List of packages in Neuron 2.14.0: Component Package Driver aws-neuronx-dkms-2.13.4.0 System Tools aws-neuronx-tools-2.14.6.0 Compiler neuron-cc-1.19.0.0 Kubernetes Plugin aws-neuronx-k8-plugin-2.17.3.0 Kubernetes Scheduler aws-neuronx-k8-scheduler-2.17.3.0 OCI aws-neuronx-oci-hook-2.2.22.0 TensorFlow tensorflow-neuron-2.10.1.2.10.1.0 TensorFlow tensorflow-neuron-2.7.4.2.10.1.0 TensorFlow tensorflow-neuron-2.8.4.2.10.1.0 TensorFlow tensorflow-neuron-2.9.3.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-1.15.0.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.10.1.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.7.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.8.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.9.3.2.10.1.0 PyTorch torch-neuron-1.10.2.2.9.1.0 PyTorch torch-neuron-1.11.0.2.9.1.0 PyTorch torch-neuron-1.12.1.2.9.1.0 PyTorch torch-neuron-1.13.1.2.9.1.0 PyTorch torch-neuron-1.9.1.2.9.1.0 MXNet mxnet_neuron-1.5.1.1.10.39.0 MXNet mx_neuron-1.8.0.2.4.10.0 Perf Tools neuronperf-1.8.7.0 Runtime Library libnrt.so (Version 2.12.23.0) Compiler dmlc_nnvm-1.17.2.0 Compiler dmlc_topi-1.17.2.0 Compiler dmlc_tvm-1.17.2.0 Compiler inferentia_hwm-1.15.2.0 ```
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>What’s New — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../_static/pygments.css"> <link rel="stylesheet" href="../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> <script src="../_static/jquery.js"></script> <script src="../_static/underscore.js"></script> <script src="../_static/doctools.js"></script> <script src="../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../_static/contentui.js"></script> <script src="../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../genindex.html"> <link rel="search" title="Search" href="../search.html"> <link rel="next" title="Announcements" href="../general/announcements/index.html"> <link rel="prev" title="Neuron Performance" href="../general/benchmarks/index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "release-notes/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1 current active"> <a class="current reference internal" href="#"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Frelease-notes/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/release-notes/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../_sources/release-notes/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-2-14-1-09-26-2023"> Neuron 2.14.1 (09/26/2023) </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-2-14-0-09-15-2023"> Neuron 2.14.0 (09/15/2023) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> What’s New </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-components-release-notes"> Neuron Components Release Notes </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#inf1-trn1-trn1n-and-inf2-common-packages"> Inf1, Trn1/Trn1n and Inf2 common packages </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#trn1-trn1n-and-inf2-only-packages"> Trn1/Trn1n and Inf2 only packages </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#inf1-only-packages"> Inf1 only packages </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-artifacts"> Release Artifacts </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#previous-releases"> Previous Releases </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>What’s New</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-2-14-1-09-26-2023"> Neuron 2.14.1 (09/26/2023) </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-2-14-0-09-15-2023"> Neuron 2.14.0 (09/15/2023) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> What’s New </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-components-release-notes"> Neuron Components Release Notes </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#inf1-trn1-trn1n-and-inf2-common-packages"> Inf1, Trn1/Trn1n and Inf2 common packages </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#trn1-trn1n-and-inf2-only-packages"> Trn1/Trn1n and Inf2 only packages </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#inf1-only-packages"> Inf1 only packages </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-artifacts"> Release Artifacts </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#previous-releases"> Previous Releases </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="what-s-new"> <span id="neuron-whatsnew"></span><h1>What’s New<a class="headerlink" href="#what-s-new" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#neuron-2-14-1-09-26-2023" id="id5">Neuron 2.14.1 (09/26/2023)</a></p></li> <li><p><a class="reference internal" href="#neuron-2-14-0-09-15-2023" id="id6">Neuron 2.14.0 (09/15/2023)</a></p></li> <li><p><a class="reference internal" href="#previous-releases" id="id7">Previous Releases</a></p></li> </ul> </div> <div class="section" id="neuron-2-14-1-09-26-2023"> <span id="neuron-2-14-0-whatsnew"></span><span id="latest-neuron-release"></span><h2><a class="toc-backref" href="#id5">Neuron 2.14.1 (09/26/2023)</a><a class="headerlink" href="#neuron-2-14-1-09-26-2023" title="Permalink to this headline">#</a></h2> <p>This is a patch release that fixes compiler issues in certain configurations of <code class="docutils literal notranslate"><span class="pre">Llama</span></code> and <code class="docutils literal notranslate"><span class="pre">Llama-2</span></code> model inference using <code class="docutils literal notranslate"><span class="pre">transformers-neuronx</span></code>.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>There is still a known compiler issue for inference of some configurations of <code class="docutils literal notranslate"><span class="pre">Llama</span></code> and <code class="docutils literal notranslate"><span class="pre">Llama-2</span></code> models that will be addressed in future Neuron release. Customers are advised to use <code class="docutils literal notranslate"><span class="pre">--optlevel</span> <span class="pre">1</span> <span class="pre">(or</span> <span class="pre">-O1)</span></code> compiler flag to mitigate this known compiler issue.</p> <p>See <a class="reference internal" href="../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">Neuron Compiler CLI Reference Guide (neuronx-cc)</span></a> on the usage of <code class="docutils literal notranslate"><span class="pre">--optlevel</span> <span class="pre">1</span></code> compiler flag. Please see more on the compiler fix and known issues in <a class="reference internal" href="compiler/neuronx-cc/index.html#neuronx-cc-rn"><span class="std std-ref">Neuron Compiler (neuronx-cc) release notes</span></a> and <a class="reference internal" href="torch/transformers-neuronx/index.html#transformers-neuronx-rn"><span class="std std-ref">Transformers Neuron (transformers-neuronx) release notes</span></a></p> </div> </div> <div class="section" id="neuron-2-14-0-09-15-2023"> <h2><a class="toc-backref" href="#id6">Neuron 2.14.0 (09/15/2023)</a><a class="headerlink" href="#neuron-2-14-0-09-15-2023" title="Permalink to this headline">#</a></h2> <div class="contents local topic" id="id1"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#id2" id="id8">What’s New</a></p></li> <li><p><a class="reference internal" href="#neuron-components-release-notes" id="id9">Neuron Components Release Notes</a></p> <ul> <li><p><a class="reference internal" href="#inf1-trn1-trn1n-and-inf2-common-packages" id="id10">Inf1, Trn1/Trn1n and Inf2 common packages</a></p></li> <li><p><a class="reference internal" href="#trn1-trn1n-and-inf2-only-packages" id="id11">Trn1/Trn1n and Inf2 only packages</a></p></li> <li><p><a class="reference internal" href="#inf1-only-packages" id="id12">Inf1 only packages</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#release-artifacts" id="id13">Release Artifacts</a></p></li> </ul> </div> <div class="section" id="id2"> <h3><a class="toc-backref" href="#id8">What’s New</a><a class="headerlink" href="#id2" title="Permalink to this headline">#</a></h3> <p>This release introduces support for <code class="docutils literal notranslate"><span class="pre">Llama-2-7B</span></code> model training and <code class="docutils literal notranslate"><span class="pre">T5-3B</span></code> model inference using <code class="docutils literal notranslate"><span class="pre">neuronx-distributed</span></code>. It also adds support for <code class="docutils literal notranslate"><span class="pre">Llama-2-13B</span></code> model training using <code class="docutils literal notranslate"><span class="pre">neuronx-nemo-megatron</span></code>. Neuron 2.14 also adds support for <code class="docutils literal notranslate"><span class="pre">Stable</span> <span class="pre">Diffusion</span> <span class="pre">XL(Refiner</span> <span class="pre">and</span> <span class="pre">Base)</span></code> model inference using <code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code> . This release also introduces other new features, performance optimizations, minor enhancements and bug fixes. This release introduces the following:</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>This release deprecates <code class="docutils literal notranslate"><span class="pre">--model-type=transformer-inference</span></code> compiler flag. Users are highly encouraged to migrate to the <code class="docutils literal notranslate"><span class="pre">--model-type=transformer</span></code> compiler flag.</p> </div> <table class="colwidths-auto table-smaller-font-size table"> <thead> <tr class="row-odd"><th class="head"><p>What’s New</p></th> <th class="head"><p>Details</p></th> <th class="head"><p>Instances</p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p>AWS Neuron Reference for Nemo Megatron library (<code class="docutils literal notranslate"><span class="pre">neuronx-nemo-megatron</span></code>)</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">Llama-2-13B</span></code> model training support ( <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples/blob/master/examples/jobs/neuronx-nemo-megatron-llamav2-job.md">tutorial</a> )</p></li> <li><p>ZeRO-1 Optimizer support that works with tensor parallelism and pipeline parallelism</p></li> <li><p>See more at <a class="reference internal" href="nemo/neuronx-nemo.html#neuronx-nemo-rn"><span class="std std-ref">AWS Neuron Reference for Nemo Megatron(neuronx-nemo-megatron) Release Notes</span></a> and <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron">neuronx-nemo-megatron github repo</a></p></li> </ul> </td> <td><p>Trn1/Trn1n</p></td> </tr> <tr class="row-odd"><td><p>Neuron Distributed (neuronx-distributed) for Training</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">pad_model</span></code> API to pad attention heads that do not divide by the number of NeuronCores, this will allow users to use any supported tensor-parallel degree. See <a class="reference internal" href="../libraries/neuronx-distributed/api_guide.html#api-guide"><span class="std std-ref">API Reference Guide (neuronx-distributed )</span></a></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">Llama-2-7B</span></code> model training support (<a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training/tp_zero1_llama2_7b_hf_pretrain">sample script</a>) (<a class="reference internal" href="../libraries/neuronx-distributed/tutorials/training_llama2_7b.html#llama2-7b-tp-zero1-tutorial"><span class="std std-ref">tutorial</span></a>)</p></li> <li><p>See more at <a class="reference internal" href="neuronx-distributed/neuronx-distributed.html#neuronx-distributed-rn"><span class="std std-ref">Neuron Distributed Release Notes (neuronx-distributed)</span></a> and <a class="reference internal" href="../libraries/neuronx-distributed/api_guide.html#api-guide"><span class="std std-ref">API Reference Guide (neuronx-distributed )</span></a></p></li> </ul> </td> <td><p>Trn1/Trn1n</p></td> </tr> <tr class="row-even"><td><p>Neuron Distributed (neuronx-distributed) for Inference</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">T5-3B</span></code> model inference support (<a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.ipynb">tutorial</a>)</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">pad_model</span></code> API to pad attention heads that do not divide by the number of NeuronCores, this will allow users to use any supported tensor-parallel degree. See <a class="reference internal" href="../libraries/neuronx-distributed/api_guide.html#api-guide"><span class="std std-ref">API Reference Guide (neuronx-distributed )</span></a></p></li> <li><p>See more at <a class="reference internal" href="neuronx-distributed/neuronx-distributed.html#neuronx-distributed-rn"><span class="std std-ref">Neuron Distributed Release Notes (neuronx-distributed)</span></a> and <a class="reference internal" href="../libraries/neuronx-distributed/api_guide.html#api-guide"><span class="std std-ref">API Reference Guide (neuronx-distributed )</span></a></p></li> </ul> </td> <td><p>Inf2,Trn1/Trn1n</p></td> </tr> <tr class="row-odd"><td><p>Transformers Neuron (transformers-neuronx) for Inference</p></td> <td><ul class="simple"> <li><p>Introducing <code class="docutils literal notranslate"><span class="pre">--model-type=transformer</span></code> compiler flag that deprecates <code class="docutils literal notranslate"><span class="pre">--model-type=transformer-inference</span></code> compiler flag.</p></li> <li><p>See more at <a class="reference internal" href="torch/transformers-neuronx/index.html#transformers-neuronx-rn"><span class="std std-ref">Transformers Neuron (transformers-neuronx) release notes</span></a></p></li> </ul> </td> <td><p>Inf2, Trn1/Trn1n</p></td> </tr> <tr class="row-even"><td><p>PyTorch Neuron (torch-neuronx)</p></td> <td><ul class="simple"> <li><p>Performance optimizations in <code class="docutils literal notranslate"><span class="pre">torch_neuronx.analyze</span></code> API. See <a class="reference internal" href="../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html#torch-neuronx-analyze-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Analyze API for Inference</span></a></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">Stable</span> <span class="pre">Diffusion</span> <span class="pre">XL(Refiner</span> <span class="pre">and</span> <span class="pre">Base)</span></code> model inference support ( <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/inference/hf_pretrained_sdxl_base_and_refiner_1024_inference.ipynb">sample script</a>)</p></li> </ul> </td> <td><p>Trn1/Trn1n,Inf2</p></td> </tr> <tr class="row-odd"><td><p>Neuron Compiler (neuronx-cc)</p></td> <td><ul class="simple"> <li><p>New <code class="docutils literal notranslate"><span class="pre">--optlevel``(or</span> <span class="pre">``-O</span></code>) compiler option that enables different optimizations with tradeoff between faster model compile time and faster model execution. See more at <a class="reference internal" href="../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">Neuron Compiler CLI Reference Guide (neuronx-cc)</span></a></p></li> <li><p>See more at <a class="reference internal" href="compiler/neuronx-cc/index.html#neuronx-cc-rn"><span class="std std-ref">Neuron Compiler (neuronx-cc) release notes</span></a></p></li> </ul> </td> <td><p>Inf2/Trn1/Trn1n</p></td> </tr> <tr class="row-even"><td><p>Neuron Tools</p></td> <td><ul class="simple"> <li><p>Neuron SysFS support for showing connected devices on <code class="docutils literal notranslate"><span class="pre">trn1.32xl</span></code>, <code class="docutils literal notranslate"><span class="pre">inf2.24xl</span></code> and <code class="docutils literal notranslate"><span class="pre">inf2.48xl</span></code> instances. See <a class="reference internal" href="../tools/neuron-sys-tools/neuron-sysfs-user-guide.html#neuron-sysfs-ug"><span class="std std-ref">Neuron Sysfs User Guide</span></a></p></li> <li><p>See more at <a class="reference internal" href="tools/aws-neuronx-tools.html#neuron-tools-rn"><span class="std std-ref">Neuron System Tools</span></a></p></li> </ul> </td> <td><p>Inf1/Inf2/Trn1/Trn1n</p></td> </tr> <tr class="row-odd"><td><p>Documentation Updates</p></td> <td><ul class="simple"> <li><p>Neuron Calculator now supports multiple model configurations for Tensor Parallel Degree computation. See <a class="reference internal" href="../general/calculator/neuron-calculator.html#neuron-calculator"><span class="std std-ref">Neuron Calculator</span></a></p></li> <li><p>Announcement to deprecate <code class="docutils literal notranslate"><span class="pre">--model-type=transformer-inference</span></code> flag. See <a class="reference internal" href="../general/announcements/neuron2.x/announce-deprecation-transformer-flag.html#announce-deprecation-transformer-flag"><span class="std std-ref">Announcing deprecation for --model-type=transformer-inference compiler flag</span></a></p></li> <li><p>See more at <a class="reference internal" href="documentation/neuron-documentation.html#neuron-documentation-rn"><span class="std std-ref">Neuron Documentation Release Notes</span></a></p></li> </ul> </td> <td><p>Inf1, Inf2, Trn1/Trn1n</p></td> </tr> <tr class="row-even"><td><p>Minor enhancements and bug fixes.</p></td> <td><ul class="simple"> <li><p>See <a class="reference internal" href="#components-rn"><span class="std std-ref">Neuron Components Release Notes</span></a></p></li> </ul> </td> <td><p>Trn1/Trn1n , Inf2, Inf1</p></td> </tr> <tr class="row-odd"><td><p>Release Artifacts</p></td> <td><ul class="simple"> <li><p>see <a class="reference internal" href="#latest-neuron-release-artifacts"><span class="std std-ref">Release Artifacts</span></a></p></li> </ul> </td> <td><p>Trn1/Trn1n , Inf2, Inf1</p></td> </tr> </tbody> </table> <p>For more detailed release notes of the new features and resolved issues, see <a class="reference internal" href="#components-rn"><span class="std std-ref">Neuron Components Release Notes</span></a>.</p> <p>To learn about the model architectures currently supported on Inf1, Inf2, Trn1 and Trn1n instances, please see <a class="reference internal" href="../general/arch/model-architecture-fit.html#model-architecture-fit"><span class="std std-ref">Model Architecture Fit Guidelines</span></a>.</p> </div> <div class="section" id="neuron-components-release-notes"> <span id="components-rn"></span><h3><a class="toc-backref" href="#id9">Neuron Components Release Notes</a><a class="headerlink" href="#neuron-components-release-notes" title="Permalink to this headline">#</a></h3> <div class="section" id="inf1-trn1-trn1n-and-inf2-common-packages"> <h4><a class="toc-backref" href="#id10">Inf1, Trn1/Trn1n and Inf2 common packages</a><a class="headerlink" href="#inf1-trn1-trn1n-and-inf2-common-packages" title="Permalink to this headline">#</a></h4> <table class="colwidths-auto table-smaller-font-size table"> <thead> <tr class="row-odd"><th class="head"><p>Component</p></th> <th class="head"><p>Instance/s</p></th> <th class="head"><p>Package/s</p></th> <th class="head"><p>Details</p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p>Neuron Runtime</p></td> <td><p>Trn1/Trn1n, Inf1, Inf2</p></td> <td><ul class="simple"> <li><p>Trn1/Trn1n: <code class="docutils literal notranslate"><span class="pre">aws-neuronx-runtime-lib</span></code> (.deb, .rpm)</p></li> <li><p>Inf1: Runtime is linked into the ML frameworks packages</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="runtime/aws-neuronx-runtime-lib/index.html#neuron-runtime-rn"><span class="std std-ref">Neuron Runtime Release Notes</span></a></p></li> </ul> </td> </tr> <tr class="row-odd"><td><p>Neuron Runtime Driver</p></td> <td><p>Trn1/Trn1n, Inf1, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aws-neuronx-dkms</span></code> (.deb, .rpm)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="runtime/aws-neuronx-dkms/index.html#neuron-driver-release-notes"><span class="std std-ref">Neuron Driver Release Notes</span></a></p></li> </ul> </td> </tr> <tr class="row-even"><td><p>Neuron System Tools</p></td> <td><p>Trn1/Trn1n, Inf1, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aws-neuronx-tools</span></code> (.deb, .rpm)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="tools/aws-neuronx-tools.html#neuron-tools-rn"><span class="std std-ref">Neuron System Tools</span></a></p></li> </ul> </td> </tr> <tr class="row-odd"><td><p>Containers</p></td> <td><p>Trn1/Trn1n, Inf1, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aws-neuronx-k8-plugin</span></code> (.deb, .rpm)</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aws-neuronx-k8-scheduler</span></code> (.deb, .rpm)</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aws-neuronx-oci-hooks</span></code> (.deb, .rpm)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="containers/neuron-k8.html#neuron-k8-rn"><span class="std std-ref">Neuron K8 Release Notes</span></a></p></li> <li><p><a class="reference internal" href="containers/neuron-containers.html#neuron-containers-release-notes"><span class="std std-ref">Neuron Containers Release Notes</span></a></p></li> </ul> </td> </tr> <tr class="row-even"><td><p>NeuronPerf (Inference only)</p></td> <td><p>Trn1/Trn1n, Inf1, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">neuronperf</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="tools/neuronperf.html#neuronperf-rn"><span class="std std-ref">NeuronPerf 1.x Release Notes</span></a></p></li> </ul> </td> </tr> <tr class="row-odd"><td><p>TensorFlow Model Server Neuron</p></td> <td><p>Trn1/Trn1n, Inf1, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">tensorflow-model-server-neuronx</span></code> (.deb, .rpm)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="tensorflow/tensorflow-modelserver-neuron/tensorflow-modelserver-neuronx.html#tensorflow-modeslserver-neuronx-rn"><span class="std std-ref">TensorFlow-Model-Server-Neuron (tensorflow-modeslserver-neuronx) Release Notes</span></a></p></li> </ul> </td> </tr> <tr class="row-even"><td><p>Neuron Documentation</p></td> <td><p>Trn1/Trn1n, Inf1, Inf2</p></td> <td><ul class="simple"> <li></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="documentation/neuron-documentation.html#neuron-documentation-rn"><span class="std std-ref">Neuron Documentation Release Notes</span></a></p></li> </ul> </td> </tr> </tbody> </table> </div> <div class="section" id="trn1-trn1n-and-inf2-only-packages"> <h4><a class="toc-backref" href="#id11">Trn1/Trn1n and Inf2 only packages</a><a class="headerlink" href="#trn1-trn1n-and-inf2-only-packages" title="Permalink to this headline">#</a></h4> <table class="colwidths-auto table-smaller-font-size table"> <thead> <tr class="row-odd"><th class="head"><p>Component</p></th> <th class="head"><p>Instance/s</p></th> <th class="head"><p>Package/s</p></th> <th class="head"><p>Details</p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p>PyTorch Neuron</p></td> <td><p>Trn1/Trn1n, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="torch/torch-neuronx/index.html#torch-neuronx-rn"><span class="std std-ref">PyTorch Neuron (torch-neuronx) release notes</span></a></p></li> <li><p><a class="reference internal" href="../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators"><span class="std std-ref">PyTorch Neuron (torch-neuronx) - Supported Operators</span></a></p></li> </ul> </td> </tr> <tr class="row-odd"><td><p>TensorFlow Neuron</p></td> <td><p>Trn1/Trn1n, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="tensorflow/tensorflow-neuronx/tensorflow-neuronx.html#tensorflow-neuronx-release-notes"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuronx) Release Notes</span></a></p></li> </ul> </td> </tr> <tr class="row-even"><td><p>Neuron Compiler (Trn1/Trn1n, Inf2 only)</p></td> <td><p>Trn1/Trn1n, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">neuronx-cc</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="compiler/neuronx-cc/index.html#neuronx-cc-rn"><span class="std std-ref">Neuron Compiler (neuronx-cc) release notes</span></a></p></li> </ul> </td> </tr> <tr class="row-odd"><td><p>Collective Communication library</p></td> <td><p>Trn1/Trn1n, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aws-neuronx-collective</span></code> (.deb, .rpm)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="runtime/aws-neuronx-collectives/index.html#neuron-collectives-rn"><span class="std std-ref">Neuron Collectives Release Notes</span></a></p></li> </ul> </td> </tr> <tr class="row-even"><td><p>Neuron Custom C++ Operators</p></td> <td><p>Trn1/Trn1n, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aws-neuronx-gpsimd-customop</span></code> (.deb, .rpm)</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aws-neuronx-gpsimd-tools</span></code> (.deb, .rpm)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="customcxxps/gpsimd-customop-lib.html#gpsimd-customop-lib-rn"><span class="std std-ref">Neuron Custom C++ Library Release Notes</span></a></p></li> <li><p><a class="reference internal" href="customcxxps/gpsimd-tools.html#gpsimd-customop-tools-rn"><span class="std std-ref">Neuron Custom C++ Tools Release Notes</span></a></p></li> </ul> </td> </tr> <tr class="row-odd"><td><p>Transformers Neuron</p></td> <td><p>Trn1/Trn1n, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">transformers-neuronx</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="torch/transformers-neuronx/index.html#transformers-neuronx-rn"><span class="std std-ref">Transformers Neuron (transformers-neuronx) release notes</span></a></p></li> </ul> </td> </tr> <tr class="row-even"><td><p>Neuron Distributed</p></td> <td><p>Trn1/Trn1n, Inf2</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">neuronx-distributed</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="neuronx-distributed/neuronx-distributed.html#neuronx-distributed-rn"><span class="std std-ref">Neuron Distributed Release Notes (neuronx-distributed)</span></a></p></li> </ul> </td> </tr> <tr class="row-odd"><td><p>AWS Neuron Reference for NeMo Megatron</p></td> <td><p>Trn1/Trn1n</p></td> <td><ul class="simple"> <li><p><a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron">neuronx-nemo-megatron github repo</a></p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="nemo/neuronx-nemo.html#neuronx-nemo-rn"><span class="std std-ref">AWS Neuron Reference for Nemo Megatron(neuronx-nemo-megatron) Release Notes</span></a></p></li> </ul> </td> </tr> </tbody> </table> <div class="admonition note"> <p class="admonition-title">Note</p> <p>In next releases <code class="docutils literal notranslate"><span class="pre">aws-neuronx-tools</span></code> and <code class="docutils literal notranslate"><span class="pre">aws-neuronx-runtime-lib</span></code> will add support for Inf1.</p> </div> </div> <div class="section" id="inf1-only-packages"> <h4><a class="toc-backref" href="#id12">Inf1 only packages</a><a class="headerlink" href="#inf1-only-packages" title="Permalink to this headline">#</a></h4> <table class="colwidths-auto table-smaller-font-size table"> <thead> <tr class="row-odd"><th class="head"><p>Component</p></th> <th class="head"><p>Instance/s</p></th> <th class="head"><p>Package/s</p></th> <th class="head"><p>Details</p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p>PyTorch Neuron</p></td> <td><p>Inf1</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="torch/torch-neuron/torch-neuron.html#pytorch-neuron-rn"><span class="std std-ref">PyTorch Neuron (torch-neuron) release notes</span></a></p></li> <li><p><a class="reference internal" href="compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a></p></li> </ul> </td> </tr> <tr class="row-odd"><td><p>TensorFlow Neuron</p></td> <td><p>Inf1</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="tensorflow/tensorflow-neuron/tensorflow-neuron.html#tensorflow-neuron-rn"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF1.x)) Release Notes</span></a></p></li> <li><p><a class="reference internal" href="compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html#neuron-cc-ops-tensorflow"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators</span></a></p></li> <li><p><a class="reference internal" href="tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html#tensorflow-neuron-rn-v2"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF2.x)) Release Notes</span></a></p></li> </ul> </td> </tr> <tr class="row-even"><td><p>Apache MXNet (Incubating)</p></td> <td><p>Inf1</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">mx_neuron</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="mxnet-neuron/mxnet-neuron.html#mxnet-neuron-rn"><span class="std std-ref">Apache MXNet Neuron (Incubating) Release Notes</span></a></p></li> <li><p><a class="reference internal" href="compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html#neuron-cc-ops-mxnet"><span class="std std-ref">Neuron Apache MXNet (Incubating) Supported operators</span></a></p></li> </ul> </td> </tr> <tr class="row-odd"><td><p>Neuron Compiler (Inf1 only)</p></td> <td><p>Inf1</p></td> <td><ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code> (.whl)</p></li> </ul> </td> <td><ul class="simple"> <li><p><a class="reference internal" href="compiler/neuron-cc/neuron-cc.html#neuron-cc-rn"><span class="std std-ref">Neuron Compiler (neuron-cc) for Inf1 Release Notes</span></a></p></li> <li><p><a class="reference internal" href="compiler/neuron-cc/neuron-cc-ops/index.html#neuron-supported-operators"><span class="std std-ref">Neuron Supported operators</span></a></p></li> </ul> </td> </tr> </tbody> </table> </div> </div> <div class="section" id="release-artifacts"> <span id="latest-neuron-release-artifacts"></span><h3><a class="toc-backref" href="#id13">Release Artifacts</a><a class="headerlink" href="#release-artifacts" title="Permalink to this headline">#</a></h3> <p>Trn1 packages</p> <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>List of packages in Neuron 2.14.1: Component Package Collective Communication Library aws-neuronx-collectives-2.17.9.0 Driver aws-neuronx-dkms-2.13.4.0 nan aws-neuronx-gpsimd-customop-lib-0.7.1.0 CustomOps Tools aws-neuronx-gpsimd-tools-0.7.0.0 General aws-neuronx-runtime-discovery-2.9 Runtime Library aws-neuronx-runtime-lib-2.17.7.0 System Tools aws-neuronx-tools-2.14.6.0 General libneuronxla-0.5.476 General neuronx_hwm-2.10.0.5 PyTorch torch_xla-1.13.1+torchneuronb Compiler neuronx-cc-2.10.0.35 Kubernetes Plugin aws-neuronx-k8-plugin-2.17.3.0 Kubernetes Scheduler aws-neuronx-k8-scheduler-2.17.3.0 OCI aws-neuronx-oci-hook-2.2.22.0 TensorFlow tensorflow-neuronx-2.10.1.2.1.0 TensorFlow tensorflow-neuronx-2.7.4.2.1.0 TensorFlow tensorflow-neuronx-2.8.4.2.1.0 TensorFlow tensorflow-neuronx-2.9.3.2.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-1.15.0.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.10.1.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.7.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.8.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.9.3.2.10.1.0 TensorBoard tensorboard-plugin-neuronx-2.5.39.0 PyTorch torch-neuronx-1.13.1.1.11.0 Transformers Neuron transformers-neuronx-0.7.84 Neuron Distributed neuronx_distributed-0.4.0 </pre></div> </div> <p>Inf2 packages</p> <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>List of packages in Neuron 2.14.1: Component Package Collective Communication Library aws-neuronx-collectives-2.17.9.0 Driver aws-neuronx-dkms-2.13.4.0 nan aws-neuronx-gpsimd-customop-lib-0.7.1.0 CustomOps Tools aws-neuronx-gpsimd-tools-0.7.0.0 General aws-neuronx-runtime-discovery-2.9 Runtime Library aws-neuronx-runtime-lib-2.17.7.0 System Tools aws-neuronx-tools-2.14.6.0 General libneuronxla-0.5.476 General neuronx_hwm-2.10.0.5 PyTorch torch_xla-1.13.1+torchneuronb Compiler neuronx-cc-2.10.0.35 Kubernetes Plugin aws-neuronx-k8-plugin-2.17.3.0 Kubernetes Scheduler aws-neuronx-k8-scheduler-2.17.3.0 OCI aws-neuronx-oci-hook-2.2.22.0 TensorFlow tensorflow-neuronx-2.10.1.2.1.0 TensorFlow tensorflow-neuronx-2.8.4.2.1.0 TensorFlow tensorflow-neuronx-2.9.3.2.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-1.15.0.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.10.1.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.7.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.8.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.9.3.2.10.1.0 TensorBoard tensorboard-plugin-neuronx-2.5.39.0 PyTorch torch-neuronx-1.13.1.1.11.0 Transformers Neuron transformers-neuronx-0.7.84 Neuron Distributed neuronx_distributed-0.4.0 </pre></div> </div> <p>Inf1 packages</p> <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>List of packages in Neuron 2.14.0: Component Package Driver aws-neuronx-dkms-2.13.4.0 System Tools aws-neuronx-tools-2.14.6.0 Compiler neuron-cc-1.19.0.0 Kubernetes Plugin aws-neuronx-k8-plugin-2.17.3.0 Kubernetes Scheduler aws-neuronx-k8-scheduler-2.17.3.0 OCI aws-neuronx-oci-hook-2.2.22.0 TensorFlow tensorflow-neuron-2.10.1.2.10.1.0 TensorFlow tensorflow-neuron-2.7.4.2.10.1.0 TensorFlow tensorflow-neuron-2.8.4.2.10.1.0 TensorFlow tensorflow-neuron-2.9.3.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-1.15.0.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.10.1.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.7.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.8.4.2.10.1.0 TensorFlow Model Server tensorflow-model-server-neuronx-2.9.3.2.10.1.0 PyTorch torch-neuron-1.10.2.2.9.1.0 PyTorch torch-neuron-1.11.0.2.9.1.0 PyTorch torch-neuron-1.12.1.2.9.1.0 PyTorch torch-neuron-1.13.1.2.9.1.0 PyTorch torch-neuron-1.9.1.2.9.1.0 MXNet mxnet_neuron-1.5.1.1.10.39.0 MXNet mx_neuron-1.8.0.2.4.10.0 Perf Tools neuronperf-1.8.7.0 Runtime Library libnrt.so (Version 2.12.23.0) Compiler dmlc_nnvm-1.17.2.0 Compiler dmlc_topi-1.17.2.0 Compiler dmlc_tvm-1.17.2.0 Compiler inferentia_hwm-1.15.2.0 </pre></div> </div> </div> </div> <div class="section" id="previous-releases"> <h2><a class="toc-backref" href="#id7">Previous Releases</a><a class="headerlink" href="#previous-releases" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p><a class="reference internal" href="prev/rn.html#prev-rn"><span class="std std-ref">Previous Releases Notes (Neuron 2.x)</span></a></p></li> <li><p><a class="reference internal" href="prev/content.html#pre-release-content"><span class="std std-ref">Previous Releases Artifacts (Neuron 2.x)</span></a></p></li> <li><p><a class="reference internal" href="neuron1/prev/rn.html#prev-n1-rn"><span class="std std-ref">Previous Release Notes (Neuron 1.x)</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../general/benchmarks/index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Neuron Performance</p> </div> </a> <a class="right-next" id="next-link" href="../general/announcements/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Announcements</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:41.277Z
Pytorch Neuron Setup — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-setup.html
# Pytorch Neuron Setup — AWS Neuron Documentation _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` ## Pytorch Neuron Setup[#](#pytorch-neuron-setup "Permalink to this headline") PyTorch Neuron (`torch-neuronx`) Setup for Inf2, Trn1/Trn1n Instances PyTorch Neuron (`torch-neuron`) Setup for Inf1 Instances _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Pytorch Neuron Setup — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Inference with torch-neuronx (Inf2 &amp; Trn1/Trn1n)" href="inference-torch-neuronx.html"> <link rel="prev" title="PyTorch Neuron" href="index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-setup", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2 current active"> <a class="current reference internal" href="#"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-setup.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-setup.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/torch/torch-setup.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Pytorch Neuron Setup</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-setup"> <span id="torch-setup"></span><h1>Pytorch Neuron Setup<a class="headerlink" href="#pytorch-neuron-setup" title="Permalink to this headline">#</a></h1> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Setup for Inf2, Trn1/Trn1n Instances</div> </div> <a class="sd-stretched-link reference internal" href="../../general/setup/torch-neuronx.html#setup-torch-neuronx"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Setup for Inf1 Instances</div> </div> <a class="sd-stretched-link reference internal" href="../../general/setup/torch-neuron.html#setup-torch-neuron"><span class="std std-ref"></span></a></div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron</p> </div> </a> <a class="right-next" id="next-link" href="inference-torch-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Inference with <code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code> (Inf2 &amp; Trn1/Trn1n)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:42.340Z
PyTorch Neuron — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/index.html
# PyTorch Neuron — AWS Neuron Documentation _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` ## PyTorch Neuron[#](#pytorch-neuron "Permalink to this headline") PyTorch Neuron unlocks high-performance and cost-effective deep learning acceleration on AWS Trainium-based and Inferentia-based Amazon EC2 instances. PyTorch Neuron plugin architecture enables native PyTorch models to be accelerated on Neuron devices, so you can use your existing framework application and get started easily with minimal code changes. PyTorch Neuron(`torch-neuronx`) for Inference on `Inf2` & `Trn1` / `Trn1n` PyTorch Neuron(`torch-neuron`) for Inference on `Inf1` PyTorch Neuron(`torch-neuronx`) for Training on `Trn1` / `Trn1n` _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Pytorch Neuron Setup" href="torch-setup.html"> <link rel="prev" title="Announcements" href="../../general/announcements/index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="current reference internal" href="#"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/torch/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron"> <span id="neuron-pytorch"></span><span id="pytorch-neuronx-main"></span><h1>PyTorch Neuron<a class="headerlink" href="#pytorch-neuron" title="Permalink to this headline">#</a></h1> <p>PyTorch Neuron unlocks high-performance and cost-effective deep learning acceleration on AWS Trainium-based and Inferentia-based Amazon EC2 instances.</p> <p>PyTorch Neuron plugin architecture enables native PyTorch models to be accelerated on Neuron devices, so you can use your existing framework application and get started easily with minimal code changes.</p> <div class="toctree-wrapper compound" id="pytorch-neuronx-training"> </div> <div class="toctree-wrapper compound"> </div> <div class="toctree-wrapper compound"> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>For help selecting a framework type for Inference, see:</p> <p><a class="reference internal" href="guide-torch-neuron-vs-torch-neuronx-inference.html#torch-neuron-vs-torch-neuronx"><span class="std std-ref">Comparison of torch-neuron (Inf1) versus torch-neuronx (Inf2 &amp; Trn1) for Inference</span></a></p> </div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> PyTorch Neuron(<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) for Inference on <code class="docutils literal notranslate"><span class="pre">Inf2</span></code> &amp; <code class="docutils literal notranslate"><span class="pre">Trn1</span></code> / <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></div> </div> <a class="sd-stretched-link reference internal" href="inference-torch-neuronx.html#inference-torch-neuronx"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> PyTorch Neuron(<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) for Inference on <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></div> </div> <a class="sd-stretched-link reference internal" href="inference-torch-neuron.html#inference-torch-neuron"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> PyTorch Neuron(<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) for Training on <code class="docutils literal notranslate"><span class="pre">Trn1</span></code> / <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></div> </div> <a class="sd-stretched-link reference internal" href="training-torch-neuronx.html#training-torch-neuronx"><span class="std std-ref"></span></a></div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../general/announcements/index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Announcements</p> </div> </a> <a class="right-next" id="next-link" href="torch-setup.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Pytorch Neuron Setup</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:42.598Z
Inference with torch-neuronx (Inf2 & Trn1/Trn1n) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/inference-torch-neuronx.html
# Inference with torch-neuronx (Inf2 & Trn1/Trn1n) — AWS Neuron Documentation next Tutorials for Inference (`torch-neuronx`)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Inference with torch-neuronx (Inf2 &amp; Trn1/Trn1n) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Tutorials for Inference (torch-neuronx)" href="torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> <link rel="prev" title="Pytorch Neuron Setup" href="torch-setup.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/inference-torch-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="current reference internal" href="#"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/inference-torch-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/inference-torch-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/torch/inference-torch-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Inference with torch-neuronx (Inf2 &amp; Trn1/Trn1n)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="inference-with-torch-neuronx-inf2-trn1-trn1n"> <span id="inference-torch-neuronx"></span><h1>Inference with <code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code> (Inf2 &amp; Trn1/Trn1n)<a class="headerlink" href="#inference-with-torch-neuronx-inf2-trn1-trn1n" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Setup (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</div> </div> <a class="sd-stretched-link reference internal" href="../../general/setup/torch-neuronx.html#setup-torch-neuronx"><span class="std std-ref"></span></a></div> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Tutorials (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text">HuggingFace pretrained BERT tutorial <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text">TorchServe tutorial <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html#pytorch-tutorials-torchserve-neuronx"><span class="std std-ref">[html]</span></a></p></li> <li><p class="sd-card-text">LibTorch C++ tutorial (for torch-neuron and torch-neuronx) <a class="reference internal" href="torch-neuron/tutorials/tutorial-libtorch.html#pytorch-tutorials-libtorch"><span class="std std-ref">[html]</span></a></p></li> <li><p class="sd-card-text">Torchvision ResNet50 tutorial <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text">T5 inference tutorial <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/torch-neuronx/t5-inference-tutorial.ipynb">[notebook]</a></p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p class="sd-card-text">To use Jupyter Notebook see:</p> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/">AWS Neuron Samples GitHub Repository</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx">Transformers Neuron GitHub samples</a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> API Reference Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch-neuronx-trace-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Tracing API for Inference</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html#torch-neuronx-core-placement-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs [Experimental]</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html#torch-neuronx-analyze-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Analyze API for Inference</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch-neuronx-dataparallel-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) DataParallel API</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-async-lazy-load.html#torch-neuronx-lazy-async-load-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Lazy and Asynchronous Loading API</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/programming-guide/inference/core-placement.html#torch-neuronx-core-placement-guide"><span class="std std-ref">NeuronCore Allocation and Model Placement for Inference (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html#trace-vs-xla-lazytensor"><span class="std std-ref">Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html#torch-neuronx-dataparallel-app-note"><span class="std std-ref">Data Parallel Inference on torch_neuronx</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Misc (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html#torch-neuronx-rn"><span class="std std-ref">PyTorch Neuron (torch-neuronx) release notes</span></a></p></li> </ul> </div> </details><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="torch-setup.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Pytorch Neuron Setup</p> </div> </a> <a class="right-next" id="next-link" href="torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Tutorials for Inference (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:43.908Z
Tutorials for Inference (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html
# Tutorials for Inference (torch-neuronx) — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Tutorials for Inference (`torch-neuronx`)[#](#tutorials-for-inference-torch-neuronx "Permalink to this headline") - HuggingFace pretrained BERT tutorial [\[html\]](../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.ipynb) - TorchServe tutorial [\[html\]](tutorial-torchserve-neuronx.html#pytorch-tutorials-torchserve-neuronx) - LibTorch C++ tutorial (for torch-neuron and torch-neuronx) [\[html\]](../../../torch-neuron/tutorials/tutorial-libtorch.html#pytorch-tutorials-libtorch) - Torchvision ResNet50 tutorial [\[html\]](../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.ipynb) - T5 inference tutorial [\[html\]](../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/torch-neuronx/t5-inference-tutorial.ipynb) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Tutorials for Inference (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> <link rel="prev" title="Inference with torch-neuronx (Inf2 &amp; Trn1/Trn1n)" href="../../../inference-torch-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Tutorials for Inference (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="tutorials-for-inference-torch-neuronx"> <span id="inference-torch-neuronx-tutorials"></span><h1>Tutorials for Inference (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#tutorials-for-inference-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p>HuggingFace pretrained BERT tutorial <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.ipynb">[notebook]</a></p></li> <li><p>TorchServe tutorial <a class="reference internal" href="tutorial-torchserve-neuronx.html#pytorch-tutorials-torchserve-neuronx"><span class="std std-ref">[html]</span></a></p></li> <li><p>LibTorch C++ tutorial (for torch-neuron and torch-neuronx) <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html#pytorch-tutorials-libtorch"><span class="std std-ref">[html]</span></a></p></li> <li><p>Torchvision ResNet50 tutorial <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.ipynb">[notebook]</a></p></li> <li><p>T5 inference tutorial <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/torch-neuronx/t5-inference-tutorial.ipynb">[notebook]</a></p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p>To use Jupyter Notebook see:</p> <ul class="simple"> <li><p><a class="reference internal" href="../../../../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p><a class="reference internal" href="../../../../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../inference-torch-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Inference with <code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code> (Inf2 &amp; Trn1/Trn1n)</p> </div> </a> <a class="right-next" id="next-link" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:44.313Z
Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html
# Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 — AWS Neuron Documentation ## Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2[#](#Compiling-and-Deploying-HuggingFace-Pretrained-BERT-on-Trn1-or-Inf2 "Permalink to this headline") ## Introduction[#](#Introduction "Permalink to this headline") In this tutorial we will compile and deploy a HuggingFace 🤗 Transformers BERT model for accelerated inference on Neuron. In this tutorial, we will be deploying directly on Trn1/Inf2 instances. If you are looking to deploy this model through SageMaker on Inf2 instance, please visit the [Sagemaker samples repository](https://github.com/aws-neuron/aws-neuron-sagemaker-samples/tree/master/inference/inf2-bert-on-sagemaker). This tutorial will use the [bert-base-cased-finetuned-mrpc](https://huggingface.co/bert-base-cased-finetuned-mrpc) model. This model has 12 layers, 768 hidden dimensions, 12 attention heads, and 110M total parameters. The final layer is a binary classification head that has been trained on the Microsoft Research Paraphrase Corpus (`mrpc`). The input to the model is two sentences and the output of the model is whether or not those sentences are a paraphrase of each other. This tutorial has the following main sections: 1. Install dependencies 2. Compile the BERT model 3. Run inference on Neuron and compare results to CPU 4. Benchmark the model using multicore inference 5. Finding the optimal batch size This Jupyter notebook should be run on a Trn1 instance (`trn1.2xlarge` or larger.) or Inf2 instance (`inf2.xlarge` or larger.) ## Install dependencies[#](#Install-dependencies "Permalink to this headline") The code in this tutorial is written for Jupyter Notebooks. To use Jupyter Notebook on the Neuron instance, you can use this [guide](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html). This tutorial requires the following pip packages: - `torch-neuronx` - `neuronx-cc` - `transformers` Most of these packages will be installed when configuring your environment using the Trn1/Inf2 setup guide. The additional dependencies must be installed here: ``` %env TOKENIZERS_PARALLELISM=True #Supresses tokenizer warnings making errors easier to detect !pip install --upgrade transformers ``` ## Compile the model into an AWS Neuron optimized TorchScript[#](#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript "Permalink to this headline") In the following section, we load the BERT model and tokenizer, get a sample input, run inference on CPU, compile the model for Neuron using `torch_neuronx.trace()`, and save the optimized model as `TorchScript`. `torch_neuronx.trace()` expects a tensor or tuple of tensor inputs to use for tracing, so we unpack the tokenizer output using the `encode` function. The result of the trace stage will be a static executable where the operations to be run upon inference are determined during compilation. This means that when inferring, the resulting Neuron model must be executed with tensors that are the exact same shape as those provided at compilation time. If a model is given a tensor at inference time whose shape does not match the tensor given at compilation time, an error will occur. For language models, the shape of the tokenizer tensors can vary based on the length of input sentence. We can satisfy the Neuron restriction of using a fixed shape input by padding all varying input tensors to a specified length. In a deployment scenario, the padding size should be chosen based on the maximum token length that is expected to occur for the application. In the following section we will assume that we will receive a maximum of 128 tokens at inference time. We will pad our example inputs by using `padding='max_length'` and to avoid potential errors caused by creating a tensor that is larger than `max_length=128`, we will always tokenize using `truncation=True`. ``` import torch import torch_neuronx from transformers import AutoTokenizer, AutoModelForSequenceClassification import transformers def encode(tokenizer, *inputs, max_length=128, batch_size=1): tokens = tokenizer.encode_plus( *inputs, max_length=max_length, padding='max_length', truncation=True, return_tensors="pt" ) return ( torch.repeat_interleave(tokens['input_ids'], batch_size, 0), torch.repeat_interleave(tokens['attention_mask'], batch_size, 0), torch.repeat_interleave(tokens['token_type_ids'], batch_size, 0), ) # Create the tokenizer and model name = "bert-base-cased-finetuned-mrpc" tokenizer = AutoTokenizer.from_pretrained(name) model = AutoModelForSequenceClassification.from_pretrained(name, torchscript=True) # Set up some example inputs sequence_0 = "The company HuggingFace is based in New York City" sequence_1 = "Apples are especially bad for your health" sequence_2 = "HuggingFace's headquarters are situated in Manhattan" paraphrase = encode(tokenizer, sequence_0, sequence_2) not_paraphrase = encode(tokenizer, sequence_0, sequence_1) # Run the original PyTorch BERT model on CPU cpu_paraphrase_logits = model(*paraphrase)[0] cpu_not_paraphrase_logits = model(*not_paraphrase)[0] # Compile the model for Neuron model_neuron = torch_neuronx.trace(model, paraphrase) # Save the TorchScript for inference deployment filename = 'model.pt' torch.jit.save(model_neuron, filename) ``` ## Run inference and compare results[#](#Run-inference-and-compare-results "Permalink to this headline") In this section we load the compiled model, run inference on Neuron, and compare the CPU and Neuron outputs. NOTE: Although this tutorial section uses one NeuronCore (and the next section uses two NeuronCores), by default each Jupyter notebook Python process will attempt to take ownership of all NeuronCores visible on the instance. For multi-process applications where each process should only use a subset of the NeuronCores on the instance you can use NEURON\_RT\_NUM\_CORES=N or NEURON\_RT\_VISIBLE\_CORES=< list of NeuronCore IDs > when starting the Jupyter notebook as described in [NeuronCore Allocation and Model Placement for Inference](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html). ``` # Load the TorchScript compiled model model_neuron = torch.jit.load(filename) # Verify the TorchScript works on both example inputs neuron_paraphrase_logits = model_neuron(*paraphrase)[0] neuron_not_paraphrase_logits = model_neuron(*not_paraphrase)[0] # Compare the results print('CPU paraphrase logits: ', cpu_paraphrase_logits.detach().numpy()) print('Neuron paraphrase logits: ', neuron_paraphrase_logits.detach().numpy()) print('CPU not-paraphrase logits: ', cpu_not_paraphrase_logits.detach().numpy()) print('Neuron not-paraphrase logits: ', neuron_not_paraphrase_logits.detach().numpy()) ``` ## Benchmarking[#](#Benchmarking "Permalink to this headline") In this section we benchmark the performance of the BERT model on Neuron. By default, models compiled with `torch_neuronx` will always execute on a _single_ NeuronCore. When loading _multiple_ models, the default behavior of the Neuron runtime is to evenly distribute models across all available NeuronCores. The runtime places models on the NeuronCore that has the fewest models loaded to it first. In the following section, we will `torch.jit.load` multiple instances of the model which should each be loaded onto their own NeuronCore. It is not useful to load more copies of a model than the number of NeuronCores on the instance since an individual NeuronCore can only execute one model at a time. To ensure that we are maximizing hardware utilization, we must run inferences using multiple threads in parallel. It is nearly always recommended to use some form of threading/multiprocessing and some form of model replication since even the smallest Neuron EC2 instance has 2 NeuronCores available. Applications with no form of threading are only capable of `1 / num_neuron_cores` hardware utilization which becomes especially problematic on large instances. One way to view the hardware utilization is by executing the `neuron-top` application in the terminal while the benchmark is executing. If the monitor shows >90% utilization on all NeuronCores, this is a good indication that the hardware is being utilized effectively. In this example we load two models, which utilizes all NeuronCores (2) on a `trn1.2xlarge` or `inf2.xlarge` instance. Additional models can be loaded and run in parallel on larger Trn1 or Inf2 instance sizes to increase throughput. We define a benchmarking function that loads two optimized BERT models onto two separate NeuronCores, runs multithreaded inference, and calculates the corresponding latency and throughput. ``` import time import concurrent.futures import numpy as np def benchmark(filename, example, n_models=2, n_threads=2, batches_per_thread=1000): """ Record performance statistics for a serialized model and its input example. Arguments: filename: The serialized torchscript model to load for benchmarking. example: An example model input. n_models: The number of models to load. n_threads: The number of simultaneous threads to execute inferences on. batches_per_thread: The number of example batches to run per thread. Returns: A dictionary of performance statistics. """ # Load models models = [torch.jit.load(filename) for _ in range(n_models)] # Warmup for _ in range(8): for model in models: model(*example) latencies = [] # Thread task def task(model): for _ in range(batches_per_thread): start = time.time() model(*example) finish = time.time() latencies.append((finish - start) * 1000) # Submit tasks begin = time.time() with concurrent.futures.ThreadPoolExecutor(max_workers=n_threads) as pool: for i in range(n_threads): pool.submit(task, models[i % len(models)]) end = time.time() # Compute metrics boundaries = [50, 95, 99] percentiles = {} for boundary in boundaries: name = f'latency_p{boundary}' percentiles[name] = np.percentile(latencies, boundary) duration = end - begin batch_size = 0 for tensor in example: if batch_size == 0: batch_size = tensor.shape[0] inferences = len(latencies) * batch_size throughput = inferences / duration # Metrics metrics = { 'filename': str(filename), 'batch_size': batch_size, 'batches': len(latencies), 'inferences': inferences, 'threads': n_threads, 'models': n_models, 'duration': duration, 'throughput': throughput, **percentiles, } display(metrics) def display(metrics): """ Display the metrics produced by `benchmark` function. Args: metrics: A dictionary of performance statistics. """ pad = max(map(len, metrics)) + 1 for key, value in metrics.items(): parts = key.split('_') parts = list(map(str.title, parts)) title = ' '.join(parts) + ":" if isinstance(value, float): value = f'{value:0.3f}' print(f'{title :<{pad}} {value}') # Benchmark BERT on Neuron benchmark(filename, paraphrase) ``` ## Finding the optimal batch size[#](#Finding-the-optimal-batch-size "Permalink to this headline") Batch size has a direct impact on model performance. The NeuronCore architecture is optimized to maximize throughput with relatively small batch sizes. This means that a Neuron compiled model can outperform a GPU model, even if running single digit batch sizes. As a general best practice, we recommend optimizing your model’s throughput by compiling the model with a small batch size and gradually increasing it to find the peak throughput on Neuron. To minimize latency, using `batch size = 1` will nearly always be optimal. This batch size configuration is typically used for on-demand inference applications. To maximize throughput, _usually_ `1 < batch_size < 10` is optimal. A configuration which uses a larger batch size is generally ideal for batched on-demand inference or offline batch processing. In the following section, we compile BERT for multiple batch size inputs. We then run inference on each batch size and benchmark the performance. Notice that latency increases consistently as the batch size increases. Throughput increases as well, up until a certain point where the input size becomes too large to be efficient. ``` # Compile BERT for different batch sizes for batch_size in [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]: tokenizer = AutoTokenizer.from_pretrained(name) model = AutoModelForSequenceClassification.from_pretrained(name, torchscript=True) example = encode(tokenizer, sequence_0, sequence_2, batch_size=batch_size) model_neuron = torch_neuronx.trace(model, example) filename = f'model_batch_size_{batch_size}.pt' torch.jit.save(model_neuron, filename) ``` ``` # Benchmark BERT for different batch sizes for batch_size in [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]: print('-'*50) example = encode(tokenizer, sequence_0, sequence_2, batch_size=batch_size) filename = f'model_batch_size_{batch_size}.pt' benchmark(filename, example) print() ```
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script>window.MathJax = {"tex": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true}, "options": {"ignoreHtmlClass": "tex2jax_ignore|mathjax_ignore|document", "processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script> <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="BERT TorchServe Tutorial" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> <link rel="prev" title="Tutorials for Inference (torch-neuronx)" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".ipynb", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"><style type="text/css">.CtxtMenu_InfoClose { top:.2em; right:.2em;} .CtxtMenu_InfoContent { overflow:auto; text-align:left; font-size:80%; padding:.4em .6em; border:1px inset; margin:1em 0px; max-height:20em; max-width:30em; background-color:#EEEEEE; white-space:normal;} .CtxtMenu_Info.CtxtMenu_MousePost {outline:none;} .CtxtMenu_Info { position:fixed; left:50%; width:auto; text-align:center; border:3px outset; padding:1em 2em; background-color:#DDDDDD; color:black; cursor:default; font-family:message-box; font-size:120%; font-style:normal; text-indent:0; text-transform:none; line-height:normal; letter-spacing:normal; word-spacing:normal; word-wrap:normal; white-space:nowrap; float:none; z-index:201; border-radius: 15px; /* Opera 10.5 and IE9 */ -webkit-border-radius:15px; /* Safari and Chrome */ -moz-border-radius:15px; /* Firefox */ -khtml-border-radius:15px; /* Konqueror */ box-shadow:0px 10px 20px #808080; /* Opera 10.5 and IE9 */ -webkit-box-shadow:0px 10px 20px #808080; /* Safari 3 & Chrome */ -moz-box-shadow:0px 10px 20px #808080; /* Forefox 3.5 */ -khtml-box-shadow:0px 10px 20px #808080; /* Konqueror */ filter:progid:DXImageTransform.Microsoft.dropshadow(OffX=2, OffY=2, Color="gray", Positive="true"); /* IE */} </style><style type="text/css">.CtxtMenu_MenuClose { position:absolute; cursor:pointer; display:inline-block; border:2px solid #AAA; border-radius:18px; -webkit-border-radius: 18px; /* Safari and Chrome */ -moz-border-radius: 18px; /* Firefox */ -khtml-border-radius: 18px; /* Konqueror */ font-family: "Courier New", Courier; font-size:24px; color:#F0F0F0} .CtxtMenu_MenuClose span { display:block; background-color:#AAA; border:1.5px solid; border-radius:18px; -webkit-border-radius: 18px; /* Safari and Chrome */ -moz-border-radius: 18px; /* Firefox */ -khtml-border-radius: 18px; /* Konqueror */ line-height:0; padding:8px 0 6px /* may need to be browser-specific */} .CtxtMenu_MenuClose:hover { color:white!important; border:2px solid #CCC!important} .CtxtMenu_MenuClose:hover span { background-color:#CCC!important} .CtxtMenu_MenuClose:hover:focus { outline:none} </style><style type="text/css">.CtxtMenu_Menu { position:absolute; background-color:white; color:black; width:auto; padding:5px 0px; border:1px solid #CCCCCC; margin:0; cursor:default; font: menu; text-align:left; text-indent:0; text-transform:none; line-height:normal; letter-spacing:normal; word-spacing:normal; word-wrap:normal; white-space:nowrap; float:none; z-index:201; border-radius: 5px; /* Opera 10.5 and IE9 */ -webkit-border-radius: 5px; /* Safari and Chrome */ -moz-border-radius: 5px; /* Firefox */ -khtml-border-radius: 5px; /* Konqueror */ box-shadow:0px 10px 20px #808080; /* Opera 10.5 and IE9 */ -webkit-box-shadow:0px 10px 20px #808080; /* Safari 3 & Chrome */ -moz-box-shadow:0px 10px 20px #808080; /* Forefox 3.5 */ -khtml-box-shadow:0px 10px 20px #808080; /* Konqueror */} .CtxtMenu_MenuItem { padding: 1px 2em; background:transparent;} .CtxtMenu_MenuArrow { position:absolute; right:.5em; padding-top:.25em; color:#666666; font-family: null; font-size: .75em} .CtxtMenu_MenuActive .CtxtMenu_MenuArrow {color:white} .CtxtMenu_MenuArrow.CtxtMenu_RTL {left:.5em; right:auto} .CtxtMenu_MenuCheck { position:absolute; left:.7em; font-family: null} .CtxtMenu_MenuCheck.CtxtMenu_RTL { right:.7em; left:auto } .CtxtMenu_MenuRadioCheck { position:absolute; left: .7em;} .CtxtMenu_MenuRadioCheck.CtxtMenu_RTL { right: .7em; left:auto} .CtxtMenu_MenuInputBox { padding-left: 1em; right:.5em; color:#666666; font-family: null;} .CtxtMenu_MenuInputBox.CtxtMenu_RTL { left: .1em;} .CtxtMenu_MenuComboBox { left:.1em; padding-bottom:.5em;} .CtxtMenu_MenuSlider { left: .1em;} .CtxtMenu_SliderValue { position:absolute; right:.1em; padding-top:.25em; color:#333333; font-size: .75em} .CtxtMenu_SliderBar { outline: none; background: #d3d3d3} .CtxtMenu_MenuLabel { padding: 1px 2em 3px 1.33em; font-style:italic} .CtxtMenu_MenuRule { border-top: 1px solid #DDDDDD; margin: 4px 3px;} .CtxtMenu_MenuDisabled { color:GrayText} .CtxtMenu_MenuActive { background-color: #606872; color: white;} .CtxtMenu_MenuDisabled:focus { background-color: #E8E8E8} .CtxtMenu_MenuLabel:focus { background-color: #E8E8E8} .CtxtMenu_ContextMenu:focus { outline:none} .CtxtMenu_ContextMenu .CtxtMenu_MenuItem:focus { outline:none} .CtxtMenu_SelectionMenu { position:relative; float:left; border-bottom: none; -webkit-box-shadow:none; -webkit-border-radius:0px; } .CtxtMenu_SelectionItem { padding-right: 1em;} .CtxtMenu_Selection { right: 40%; width:50%; } .CtxtMenu_SelectionBox { padding: 0em; max-height:20em; max-width: none; background-color:#FFFFFF;} .CtxtMenu_SelectionDivider { clear: both; border-top: 2px solid #000000;} .CtxtMenu_Menu .CtxtMenu_MenuClose { top:-10px; left:-10px} </style><style id="MJX-CHTML-styles"> mjx-container[jax="CHTML"] { line-height: 0; } mjx-container [space="1"] { margin-left: .111em; } mjx-container [space="2"] { margin-left: .167em; } mjx-container [space="3"] { margin-left: .222em; } mjx-container [space="4"] { margin-left: .278em; } mjx-container [space="5"] { margin-left: .333em; } mjx-container [rspace="1"] { margin-right: .111em; } mjx-container [rspace="2"] { margin-right: .167em; } mjx-container [rspace="3"] { margin-right: .222em; } mjx-container [rspace="4"] { margin-right: .278em; } mjx-container [rspace="5"] { margin-right: .333em; } mjx-container [size="s"] { font-size: 70.7%; } mjx-container [size="ss"] { font-size: 50%; } mjx-container [size="Tn"] { font-size: 60%; } mjx-container [size="sm"] { font-size: 85%; } mjx-container [size="lg"] { font-size: 120%; } mjx-container [size="Lg"] { font-size: 144%; } mjx-container [size="LG"] { font-size: 173%; } mjx-container [size="hg"] { font-size: 207%; } mjx-container [size="HG"] { font-size: 249%; } mjx-container [width="full"] { width: 100%; } mjx-box { display: inline-block; } mjx-block { display: block; } mjx-itable { display: inline-table; } mjx-row { display: table-row; } mjx-row > * { display: table-cell; } mjx-mtext { display: inline-block; } mjx-mstyle { display: inline-block; } mjx-merror { display: inline-block; color: red; background-color: yellow; } mjx-mphantom { visibility: hidden; } _::-webkit-full-page-media, _:future, :root mjx-container { will-change: opacity; } mjx-assistive-mml { position: absolute !important; top: 0px; left: 0px; clip: rect(1px, 1px, 1px, 1px); padding: 1px 0px 0px 0px !important; border: 0px !important; display: block !important; width: auto !important; overflow: hidden !important; -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } mjx-assistive-mml[display="block"] { width: 100% !important; } mjx-c::before { display: block; width: 0; } .MJX-TEX { font-family: MJXZERO, MJXTEX; } .TEX-B { font-family: MJXZERO, MJXTEX-B; } .TEX-I { font-family: MJXZERO, MJXTEX-I; } .TEX-MI { font-family: MJXZERO, MJXTEX-MI; } .TEX-BI { font-family: MJXZERO, MJXTEX-BI; } .TEX-S1 { font-family: MJXZERO, MJXTEX-S1; } .TEX-S2 { font-family: MJXZERO, MJXTEX-S2; } .TEX-S3 { font-family: MJXZERO, MJXTEX-S3; } .TEX-S4 { font-family: MJXZERO, MJXTEX-S4; } .TEX-A { font-family: MJXZERO, MJXTEX-A; } .TEX-C { font-family: MJXZERO, MJXTEX-C; } .TEX-CB { font-family: MJXZERO, MJXTEX-CB; } .TEX-FR { font-family: MJXZERO, MJXTEX-FR; } .TEX-FRB { font-family: MJXZERO, MJXTEX-FRB; } .TEX-SS { font-family: MJXZERO, MJXTEX-SS; } .TEX-SSB { font-family: MJXZERO, MJXTEX-SSB; } .TEX-SSI { font-family: MJXZERO, MJXTEX-SSI; } .TEX-SC { font-family: MJXZERO, MJXTEX-SC; } .TEX-T { font-family: MJXZERO, MJXTEX-T; } .TEX-V { font-family: MJXZERO, MJXTEX-V; } .TEX-VB { font-family: MJXZERO, MJXTEX-VB; } mjx-stretchy-v mjx-c, mjx-stretchy-h mjx-c { font-family: MJXZERO, MJXTEX-S1, MJXTEX-S4, MJXTEX, MJXTEX-A ! important; } @font-face /* 0 */ { font-family: MJXZERO; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Zero.woff") format("woff"); } @font-face /* 1 */ { font-family: MJXTEX; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Regular.woff") format("woff"); } @font-face /* 2 */ { font-family: MJXTEX-B; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Bold.woff") format("woff"); } @font-face /* 3 */ { font-family: MJXTEX-I; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Math-Italic.woff") format("woff"); } @font-face /* 4 */ { font-family: MJXTEX-MI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Italic.woff") format("woff"); } @font-face /* 5 */ { font-family: MJXTEX-BI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Math-BoldItalic.woff") format("woff"); } @font-face /* 6 */ { font-family: MJXTEX-S1; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size1-Regular.woff") format("woff"); } @font-face /* 7 */ { font-family: MJXTEX-S2; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size2-Regular.woff") format("woff"); } @font-face /* 8 */ { font-family: MJXTEX-S3; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size3-Regular.woff") format("woff"); } @font-face /* 9 */ { font-family: MJXTEX-S4; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size4-Regular.woff") format("woff"); } @font-face /* 10 */ { font-family: MJXTEX-A; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_AMS-Regular.woff") format("woff"); } @font-face /* 11 */ { font-family: MJXTEX-C; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Regular.woff") format("woff"); } @font-face /* 12 */ { font-family: MJXTEX-CB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Bold.woff") format("woff"); } @font-face /* 13 */ { font-family: MJXTEX-FR; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Regular.woff") format("woff"); } @font-face /* 14 */ { font-family: MJXTEX-FRB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Bold.woff") format("woff"); } @font-face /* 15 */ { font-family: MJXTEX-SS; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Regular.woff") format("woff"); } @font-face /* 16 */ { font-family: MJXTEX-SSB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Bold.woff") format("woff"); } @font-face /* 17 */ { font-family: MJXTEX-SSI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Italic.woff") format("woff"); } @font-face /* 18 */ { font-family: MJXTEX-SC; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Script-Regular.woff") format("woff"); } @font-face /* 19 */ { font-family: MJXTEX-T; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Typewriter-Regular.woff") format("woff"); } @font-face /* 20 */ { font-family: MJXTEX-V; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Regular.woff") format("woff"); } @font-face /* 21 */ { font-family: MJXTEX-VB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Bold.woff") format("woff"); } </style></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fsrc/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.ipynb" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.ipynb.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.ipynb</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Install-dependencies"> Install dependencies </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript"> Compile the model into an AWS Neuron optimized TorchScript </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-inference-and-compare-results"> Run inference and compare results </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Benchmarking"> Benchmarking </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Finding-the-optimal-batch-size"> Finding the optimal batch size </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Install-dependencies"> Install dependencies </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript"> Compile the model into an AWS Neuron optimized TorchScript </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-inference-and-compare-results"> Run inference and compare results </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Benchmarking"> Benchmarking </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Finding-the-optimal-batch-size"> Finding the optimal batch size </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <style> /* CSS for nbsphinx extension */ /* remove conflicting styling from Sphinx themes */ div.nbinput.container div.prompt *, div.nboutput.container div.prompt *, div.nbinput.container div.input_area pre, div.nboutput.container div.output_area pre, div.nbinput.container div.input_area .highlight, div.nboutput.container div.output_area .highlight { border: none; padding: 0; margin: 0; box-shadow: none; } div.nbinput.container > div[class*=highlight], div.nboutput.container > div[class*=highlight] { margin: 0; } div.nbinput.container div.prompt *, div.nboutput.container div.prompt * { background: none; } div.nboutput.container div.output_area .highlight, div.nboutput.container div.output_area pre { background: unset; } div.nboutput.container div.output_area div.highlight { color: unset; /* override Pygments text color */ } /* avoid gaps between output lines */ div.nboutput.container div[class*=highlight] pre { line-height: normal; } /* input/output containers */ div.nbinput.container, div.nboutput.container { display: -webkit-flex; display: flex; align-items: flex-start; margin: 0; width: 100%; } @media (max-width: 540px) { div.nbinput.container, div.nboutput.container { flex-direction: column; } } /* input container */ div.nbinput.container { padding-top: 5px; } /* last container */ div.nblast.container { padding-bottom: 5px; } /* input prompt */ div.nbinput.container div.prompt pre { color: #307FC1; } /* output prompt */ div.nboutput.container div.prompt pre { color: #BF5B3D; } /* all prompts */ div.nbinput.container div.prompt, div.nboutput.container div.prompt { width: 4.5ex; padding-top: 5px; position: relative; user-select: none; } div.nbinput.container div.prompt > div, div.nboutput.container div.prompt > div { position: absolute; right: 0; margin-right: 0.3ex; } @media (max-width: 540px) { div.nbinput.container div.prompt, div.nboutput.container div.prompt { width: unset; text-align: left; padding: 0.4em; } div.nboutput.container div.prompt.empty { padding: 0; } div.nbinput.container div.prompt > div, div.nboutput.container div.prompt > div { position: unset; } } /* disable scrollbars on prompts */ div.nbinput.container div.prompt pre, div.nboutput.container div.prompt pre { overflow: hidden; } /* input/output area */ div.nbinput.container div.input_area, div.nboutput.container div.output_area { -webkit-flex: 1; flex: 1; overflow: auto; } @media (max-width: 540px) { div.nbinput.container div.input_area, div.nboutput.container div.output_area { width: 100%; } } /* input area */ div.nbinput.container div.input_area { border: 1px solid #e0e0e0; border-radius: 2px; /*background: #f5f5f5;*/ } /* override MathJax center alignment in output cells */ div.nboutput.container div[class*=MathJax] { text-align: left !important; } /* override sphinx.ext.imgmath center alignment in output cells */ div.nboutput.container div.math p { text-align: left; } /* standard error */ div.nboutput.container div.output_area.stderr { background: #fdd; } /* ANSI colors */ .ansi-black-fg { color: #3E424D; } .ansi-black-bg { background-color: #3E424D; } .ansi-black-intense-fg { color: #282C36; } .ansi-black-intense-bg { background-color: #282C36; } .ansi-red-fg { color: #E75C58; } .ansi-red-bg { background-color: #E75C58; } .ansi-red-intense-fg { color: #B22B31; } .ansi-red-intense-bg { background-color: #B22B31; } .ansi-green-fg { color: #00A250; } .ansi-green-bg { background-color: #00A250; } .ansi-green-intense-fg { color: #007427; } .ansi-green-intense-bg { background-color: #007427; } .ansi-yellow-fg { color: #DDB62B; } .ansi-yellow-bg { background-color: #DDB62B; } .ansi-yellow-intense-fg { color: #B27D12; } .ansi-yellow-intense-bg { background-color: #B27D12; } .ansi-blue-fg { color: #208FFB; } .ansi-blue-bg { background-color: #208FFB; } .ansi-blue-intense-fg { color: #0065CA; } .ansi-blue-intense-bg { background-color: #0065CA; } .ansi-magenta-fg { color: #D160C4; } .ansi-magenta-bg { background-color: #D160C4; } .ansi-magenta-intense-fg { color: #A03196; } .ansi-magenta-intense-bg { background-color: #A03196; } .ansi-cyan-fg { color: #60C6C8; } .ansi-cyan-bg { background-color: #60C6C8; } .ansi-cyan-intense-fg { color: #258F8F; } .ansi-cyan-intense-bg { background-color: #258F8F; } .ansi-white-fg { color: #C5C1B4; } .ansi-white-bg { background-color: #C5C1B4; } .ansi-white-intense-fg { color: #A1A6B2; } .ansi-white-intense-bg { background-color: #A1A6B2; } .ansi-default-inverse-fg { color: #FFFFFF; } .ansi-default-inverse-bg { background-color: #000000; } .ansi-bold { font-weight: bold; } .ansi-underline { text-decoration: underline; } div.nbinput.container div.input_area div[class*=highlight] > pre, div.nboutput.container div.output_area div[class*=highlight] > pre, div.nboutput.container div.output_area div[class*=highlight].math, div.nboutput.container div.output_area.rendered_html, div.nboutput.container div.output_area > div.output_javascript, div.nboutput.container div.output_area:not(.rendered_html) > img{ padding: 5px; margin: 0; } /* fix copybtn overflow problem in chromium (needed for 'sphinx_copybutton') */ div.nbinput.container div.input_area > div[class^='highlight'], div.nboutput.container div.output_area > div[class^='highlight']{ overflow-y: hidden; } /* hide copybtn icon on prompts (needed for 'sphinx_copybutton') */ .prompt .copybtn { display: none; } /* Some additional styling taken form the Jupyter notebook CSS */ .jp-RenderedHTMLCommon table, div.rendered_html table { border: none; border-collapse: collapse; border-spacing: 0; color: black; font-size: 12px; table-layout: fixed; } .jp-RenderedHTMLCommon thead, div.rendered_html thead { border-bottom: 1px solid black; vertical-align: bottom; } .jp-RenderedHTMLCommon tr, .jp-RenderedHTMLCommon th, .jp-RenderedHTMLCommon td, div.rendered_html tr, div.rendered_html th, div.rendered_html td { text-align: right; vertical-align: middle; padding: 0.5em 0.5em; line-height: normal; white-space: normal; max-width: none; border: none; } .jp-RenderedHTMLCommon th, div.rendered_html th { font-weight: bold; } .jp-RenderedHTMLCommon tbody tr:nth-child(odd), div.rendered_html tbody tr:nth-child(odd) { background: #f5f5f5; } .jp-RenderedHTMLCommon tbody tr:hover, div.rendered_html tbody tr:hover { background: rgba(66, 165, 245, 0.2); } </style> <div class="section" id="Compiling-and-Deploying-HuggingFace-Pretrained-BERT-on-Trn1-or-Inf2"> <h1>Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2<a class="headerlink" href="#Compiling-and-Deploying-HuggingFace-Pretrained-BERT-on-Trn1-or-Inf2" title="Permalink to this headline">#</a></h1> <div class="section" id="Introduction"> <h2>Introduction<a class="headerlink" href="#Introduction" title="Permalink to this headline">#</a></h2> <p>In this tutorial we will compile and deploy a HuggingFace 🤗 Transformers BERT model for accelerated inference on Neuron. In this tutorial, we will be deploying directly on Trn1/Inf2 instances. If you are looking to deploy this model through SageMaker on Inf2 instance, please visit the <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples/tree/master/inference/inf2-bert-on-sagemaker">Sagemaker samples repository</a>.</p> <p>This tutorial will use the <a class="reference external" href="https://huggingface.co/bert-base-cased-finetuned-mrpc">bert-base-cased-finetuned-mrpc</a> model. This model has 12 layers, 768 hidden dimensions, 12 attention heads, and 110M total parameters. The final layer is a binary classification head that has been trained on the Microsoft Research Paraphrase Corpus (<code class="docutils literal notranslate"><span class="pre">mrpc</span></code>). The input to the model is two sentences and the output of the model is whether or not those sentences are a paraphrase of each other.</p> <p>This tutorial has the following main sections:</p> <ol class="arabic simple"> <li><p>Install dependencies</p></li> <li><p>Compile the BERT model</p></li> <li><p>Run inference on Neuron and compare results to CPU</p></li> <li><p>Benchmark the model using multicore inference</p></li> <li><p>Finding the optimal batch size</p></li> </ol> <p>This Jupyter notebook should be run on a Trn1 instance (<code class="docutils literal notranslate"><span class="pre">trn1.2xlarge</span></code> or larger.) or Inf2 instance (<code class="docutils literal notranslate"><span class="pre">inf2.xlarge</span></code> or larger.)</p> </div> <div class="section" id="Install-dependencies"> <h2>Install dependencies<a class="headerlink" href="#Install-dependencies" title="Permalink to this headline">#</a></h2> <p>The code in this tutorial is written for Jupyter Notebooks. To use Jupyter Notebook on the Neuron instance, you can use this <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html">guide</a>.</p> <p>This tutorial requires the following pip packages:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">neuronx-cc</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">transformers</span></code></p></li> </ul> <p>Most of these packages will be installed when configuring your environment using the Trn1/Inf2 setup guide. The additional dependencies must be installed here:</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="k">env</span> TOKENIZERS_PARALLELISM=True #Supresses tokenizer warnings making errors easier to detect <span class="o">!</span>pip<span class="w"> </span>install<span class="w"> </span>--upgrade<span class="w"> </span>transformers </pre></div> </div> </div> </div> <div class="section" id="Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript"> <h2>Compile the model into an AWS Neuron optimized TorchScript<a class="headerlink" href="#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript" title="Permalink to this headline">#</a></h2> <p>In the following section, we load the BERT model and tokenizer, get a sample input, run inference on CPU, compile the model for Neuron using <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code>, and save the optimized model as <code class="docutils literal notranslate"><span class="pre">TorchScript</span></code>.</p> <p><code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code> expects a tensor or tuple of tensor inputs to use for tracing, so we unpack the tokenizer output using the <code class="docutils literal notranslate"><span class="pre">encode</span></code> function.</p> <p>The result of the trace stage will be a static executable where the operations to be run upon inference are determined during compilation. This means that when inferring, the resulting Neuron model must be executed with tensors that are the exact same shape as those provided at compilation time. If a model is given a tensor at inference time whose shape does not match the tensor given at compilation time, an error will occur.</p> <p>For language models, the shape of the tokenizer tensors can vary based on the length of input sentence. We can satisfy the Neuron restriction of using a fixed shape input by padding all varying input tensors to a specified length. In a deployment scenario, the padding size should be chosen based on the maximum token length that is expected to occur for the application.</p> <p>In the following section we will assume that we will receive a maximum of 128 tokens at inference time. We will pad our example inputs by using <code class="docutils literal notranslate"><span class="pre">padding='max_length'</span></code> and to avoid potential errors caused by creating a tensor that is larger than <code class="docutils literal notranslate"><span class="pre">max_length=128</span></code>, we will always tokenize using <code class="docutils literal notranslate"><span class="pre">truncation=True</span></code>.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">AutoTokenizer</span><span class="p">,</span> <span class="n">AutoModelForSequenceClassification</span> <span class="kn">import</span> <span class="nn">transformers</span> <span class="k">def</span> <span class="nf">encode</span><span class="p">(</span><span class="n">tokenizer</span><span class="p">,</span> <span class="o">*</span><span class="n">inputs</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="mi">128</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span> <span class="n">tokens</span> <span class="o">=</span> <span class="n">tokenizer</span><span class="o">.</span><span class="n">encode_plus</span><span class="p">(</span> <span class="o">*</span><span class="n">inputs</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">,</span> <span class="n">padding</span><span class="o">=</span><span class="s1">'max_length'</span><span class="p">,</span> <span class="n">truncation</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">return_tensors</span><span class="o">=</span><span class="s2">"pt"</span> <span class="p">)</span> <span class="k">return</span> <span class="p">(</span> <span class="n">torch</span><span class="o">.</span><span class="n">repeat_interleave</span><span class="p">(</span><span class="n">tokens</span><span class="p">[</span><span class="s1">'input_ids'</span><span class="p">],</span> <span class="n">batch_size</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">repeat_interleave</span><span class="p">(</span><span class="n">tokens</span><span class="p">[</span><span class="s1">'attention_mask'</span><span class="p">],</span> <span class="n">batch_size</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">repeat_interleave</span><span class="p">(</span><span class="n">tokens</span><span class="p">[</span><span class="s1">'token_type_ids'</span><span class="p">],</span> <span class="n">batch_size</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="p">)</span> <span class="c1"># Create the tokenizer and model</span> <span class="n">name</span> <span class="o">=</span> <span class="s2">"bert-base-cased-finetuned-mrpc"</span> <span class="n">tokenizer</span> <span class="o">=</span> <span class="n">AutoTokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">AutoModelForSequenceClassification</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">torchscript</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># Set up some example inputs</span> <span class="n">sequence_0</span> <span class="o">=</span> <span class="s2">"The company HuggingFace is based in New York City"</span> <span class="n">sequence_1</span> <span class="o">=</span> <span class="s2">"Apples are especially bad for your health"</span> <span class="n">sequence_2</span> <span class="o">=</span> <span class="s2">"HuggingFace's headquarters are situated in Manhattan"</span> <span class="n">paraphrase</span> <span class="o">=</span> <span class="n">encode</span><span class="p">(</span><span class="n">tokenizer</span><span class="p">,</span> <span class="n">sequence_0</span><span class="p">,</span> <span class="n">sequence_2</span><span class="p">)</span> <span class="n">not_paraphrase</span> <span class="o">=</span> <span class="n">encode</span><span class="p">(</span><span class="n">tokenizer</span><span class="p">,</span> <span class="n">sequence_0</span><span class="p">,</span> <span class="n">sequence_1</span><span class="p">)</span> <span class="c1"># Run the original PyTorch BERT model on CPU</span> <span class="n">cpu_paraphrase_logits</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="o">*</span><span class="n">paraphrase</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="n">cpu_not_paraphrase_logits</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="o">*</span><span class="n">not_paraphrase</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># Compile the model for Neuron</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">paraphrase</span><span class="p">)</span> <span class="c1"># Save the TorchScript for inference deployment</span> <span class="n">filename</span> <span class="o">=</span> <span class="s1">'model.pt'</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="Run-inference-and-compare-results"> <h2>Run inference and compare results<a class="headerlink" href="#Run-inference-and-compare-results" title="Permalink to this headline">#</a></h2> <p>In this section we load the compiled model, run inference on Neuron, and compare the CPU and Neuron outputs.</p> <p>NOTE: Although this tutorial section uses one NeuronCore (and the next section uses two NeuronCores), by default each Jupyter notebook Python process will attempt to take ownership of all NeuronCores visible on the instance. For multi-process applications where each process should only use a subset of the NeuronCores on the instance you can use NEURON_RT_NUM_CORES=N or NEURON_RT_VISIBLE_CORES=&lt; list of NeuronCore IDs &gt; when starting the Jupyter notebook as described in <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html">NeuronCore Allocation and Model Placement for Inference</a>.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Load the TorchScript compiled model</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="c1"># Verify the TorchScript works on both example inputs</span> <span class="n">neuron_paraphrase_logits</span> <span class="o">=</span> <span class="n">model_neuron</span><span class="p">(</span><span class="o">*</span><span class="n">paraphrase</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="n">neuron_not_paraphrase_logits</span> <span class="o">=</span> <span class="n">model_neuron</span><span class="p">(</span><span class="o">*</span><span class="n">not_paraphrase</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># Compare the results</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'CPU paraphrase logits: '</span><span class="p">,</span> <span class="n">cpu_paraphrase_logits</span><span class="o">.</span><span class="n">detach</span><span class="p">()</span><span class="o">.</span><span class="n">numpy</span><span class="p">())</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Neuron paraphrase logits: '</span><span class="p">,</span> <span class="n">neuron_paraphrase_logits</span><span class="o">.</span><span class="n">detach</span><span class="p">()</span><span class="o">.</span><span class="n">numpy</span><span class="p">())</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'CPU not-paraphrase logits: '</span><span class="p">,</span> <span class="n">cpu_not_paraphrase_logits</span><span class="o">.</span><span class="n">detach</span><span class="p">()</span><span class="o">.</span><span class="n">numpy</span><span class="p">())</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Neuron not-paraphrase logits: '</span><span class="p">,</span> <span class="n">neuron_not_paraphrase_logits</span><span class="o">.</span><span class="n">detach</span><span class="p">()</span><span class="o">.</span><span class="n">numpy</span><span class="p">())</span> </pre></div> </div> </div> </div> <div class="section" id="Benchmarking"> <h2>Benchmarking<a class="headerlink" href="#Benchmarking" title="Permalink to this headline">#</a></h2> <p>In this section we benchmark the performance of the BERT model on Neuron. By default, models compiled with <code class="docutils literal notranslate"><span class="pre">torch_neuronx</span></code> will always execute on a <em>single</em> NeuronCore. When loading <em>multiple</em> models, the default behavior of the Neuron runtime is to evenly distribute models across all available NeuronCores. The runtime places models on the NeuronCore that has the fewest models loaded to it first. In the following section, we will <code class="docutils literal notranslate"><span class="pre">torch.jit.load</span></code> multiple instances of the model which should each be loaded onto their own NeuronCore. It is not useful to load more copies of a model than the number of NeuronCores on the instance since an individual NeuronCore can only execute one model at a time.</p> <p>To ensure that we are maximizing hardware utilization, we must run inferences using multiple threads in parallel. It is nearly always recommended to use some form of threading/multiprocessing and some form of model replication since even the smallest Neuron EC2 instance has 2 NeuronCores available. Applications with no form of threading are only capable of <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">/</span> <span class="pre">num_neuron_cores</span></code> hardware utilization which becomes especially problematic on large instances.</p> <p>One way to view the hardware utilization is by executing the <code class="docutils literal notranslate"><span class="pre">neuron-top</span></code> application in the terminal while the benchmark is executing. If the monitor shows &gt;90% utilization on all NeuronCores, this is a good indication that the hardware is being utilized effectively.</p> <p>In this example we load two models, which utilizes all NeuronCores (2) on a <code class="docutils literal notranslate"><span class="pre">trn1.2xlarge</span></code> or <code class="docutils literal notranslate"><span class="pre">inf2.xlarge</span></code> instance. Additional models can be loaded and run in parallel on larger Trn1 or Inf2 instance sizes to increase throughput.</p> <p>We define a benchmarking function that loads two optimized BERT models onto two separate NeuronCores, runs multithreaded inference, and calculates the corresponding latency and throughput.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">time</span> <span class="kn">import</span> <span class="nn">concurrent.futures</span> <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> <span class="k">def</span> <span class="nf">benchmark</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">example</span><span class="p">,</span> <span class="n">n_models</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">n_threads</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">batches_per_thread</span><span class="o">=</span><span class="mi">1000</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""</span> <span class="sd"> Record performance statistics for a serialized model and its input example.</span> <span class="sd"> Arguments:</span> <span class="sd"> filename: The serialized torchscript model to load for benchmarking.</span> <span class="sd"> example: An example model input.</span> <span class="sd"> n_models: The number of models to load.</span> <span class="sd"> n_threads: The number of simultaneous threads to execute inferences on.</span> <span class="sd"> batches_per_thread: The number of example batches to run per thread.</span> <span class="sd"> Returns:</span> <span class="sd"> A dictionary of performance statistics.</span> <span class="sd"> """</span> <span class="c1"># Load models</span> <span class="n">models</span> <span class="o">=</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n_models</span><span class="p">)]</span> <span class="c1"># Warmup</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">8</span><span class="p">):</span> <span class="k">for</span> <span class="n">model</span> <span class="ow">in</span> <span class="n">models</span><span class="p">:</span> <span class="n">model</span><span class="p">(</span><span class="o">*</span><span class="n">example</span><span class="p">)</span> <span class="n">latencies</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># Thread task</span> <span class="k">def</span> <span class="nf">task</span><span class="p">(</span><span class="n">model</span><span class="p">):</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">batches_per_thread</span><span class="p">):</span> <span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="n">model</span><span class="p">(</span><span class="o">*</span><span class="n">example</span><span class="p">)</span> <span class="n">finish</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="n">latencies</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">finish</span> <span class="o">-</span> <span class="n">start</span><span class="p">)</span> <span class="o">*</span> <span class="mi">1000</span><span class="p">)</span> <span class="c1"># Submit tasks</span> <span class="n">begin</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="k">with</span> <span class="n">concurrent</span><span class="o">.</span><span class="n">futures</span><span class="o">.</span><span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="n">n_threads</span><span class="p">)</span> <span class="k">as</span> <span class="n">pool</span><span class="p">:</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n_threads</span><span class="p">):</span> <span class="n">pool</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">task</span><span class="p">,</span> <span class="n">models</span><span class="p">[</span><span class="n">i</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">models</span><span class="p">)])</span> <span class="n">end</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="c1"># Compute metrics</span> <span class="n">boundaries</span> <span class="o">=</span> <span class="p">[</span><span class="mi">50</span><span class="p">,</span> <span class="mi">95</span><span class="p">,</span> <span class="mi">99</span><span class="p">]</span> <span class="n">percentiles</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">for</span> <span class="n">boundary</span> <span class="ow">in</span> <span class="n">boundaries</span><span class="p">:</span> <span class="n">name</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'latency_p</span><span class="si">{</span><span class="n">boundary</span><span class="si">}</span><span class="s1">'</span> <span class="n">percentiles</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">percentile</span><span class="p">(</span><span class="n">latencies</span><span class="p">,</span> <span class="n">boundary</span><span class="p">)</span> <span class="n">duration</span> <span class="o">=</span> <span class="n">end</span> <span class="o">-</span> <span class="n">begin</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">for</span> <span class="n">tensor</span> <span class="ow">in</span> <span class="n">example</span><span class="p">:</span> <span class="k">if</span> <span class="n">batch_size</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="n">tensor</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="n">inferences</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">latencies</span><span class="p">)</span> <span class="o">*</span> <span class="n">batch_size</span> <span class="n">throughput</span> <span class="o">=</span> <span class="n">inferences</span> <span class="o">/</span> <span class="n">duration</span> <span class="c1"># Metrics</span> <span class="n">metrics</span> <span class="o">=</span> <span class="p">{</span> <span class="s1">'filename'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">filename</span><span class="p">),</span> <span class="s1">'batch_size'</span><span class="p">:</span> <span class="n">batch_size</span><span class="p">,</span> <span class="s1">'batches'</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">latencies</span><span class="p">),</span> <span class="s1">'inferences'</span><span class="p">:</span> <span class="n">inferences</span><span class="p">,</span> <span class="s1">'threads'</span><span class="p">:</span> <span class="n">n_threads</span><span class="p">,</span> <span class="s1">'models'</span><span class="p">:</span> <span class="n">n_models</span><span class="p">,</span> <span class="s1">'duration'</span><span class="p">:</span> <span class="n">duration</span><span class="p">,</span> <span class="s1">'throughput'</span><span class="p">:</span> <span class="n">throughput</span><span class="p">,</span> <span class="o">**</span><span class="n">percentiles</span><span class="p">,</span> <span class="p">}</span> <span class="n">display</span><span class="p">(</span><span class="n">metrics</span><span class="p">)</span> <span class="k">def</span> <span class="nf">display</span><span class="p">(</span><span class="n">metrics</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""</span> <span class="sd"> Display the metrics produced by `benchmark` function.</span> <span class="sd"> Args:</span> <span class="sd"> metrics: A dictionary of performance statistics.</span> <span class="sd"> """</span> <span class="n">pad</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">len</span><span class="p">,</span> <span class="n">metrics</span><span class="p">))</span> <span class="o">+</span> <span class="mi">1</span> <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">metrics</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> <span class="n">parts</span> <span class="o">=</span> <span class="n">key</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'_'</span><span class="p">)</span> <span class="n">parts</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">title</span><span class="p">,</span> <span class="n">parts</span><span class="p">))</span> <span class="n">title</span> <span class="o">=</span> <span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">parts</span><span class="p">)</span> <span class="o">+</span> <span class="s2">":"</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">float</span><span class="p">):</span> <span class="n">value</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="n">value</span><span class="si">:</span><span class="s1">0.3f</span><span class="si">}</span><span class="s1">'</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="n">title</span><span class="w"> </span><span class="si">:</span><span class="s1">&lt;</span><span class="si">{</span><span class="n">pad</span><span class="si">}}</span><span class="s1"> </span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span> <span class="c1"># Benchmark BERT on Neuron</span> <span class="n">benchmark</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">paraphrase</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="Finding-the-optimal-batch-size"> <h2>Finding the optimal batch size<a class="headerlink" href="#Finding-the-optimal-batch-size" title="Permalink to this headline">#</a></h2> <p>Batch size has a direct impact on model performance. The NeuronCore architecture is optimized to maximize throughput with relatively small batch sizes. This means that a Neuron compiled model can outperform a GPU model, even if running single digit batch sizes.</p> <p>As a general best practice, we recommend optimizing your model’s throughput by compiling the model with a small batch size and gradually increasing it to find the peak throughput on Neuron. To minimize latency, using <code class="docutils literal notranslate"><span class="pre">batch</span> <span class="pre">size</span> <span class="pre">=</span> <span class="pre">1</span></code> will nearly always be optimal. This batch size configuration is typically used for on-demand inference applications. To maximize throughput, <em>usually</em> <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">&lt;</span> <span class="pre">batch_size</span> <span class="pre">&lt;</span> <span class="pre">10</span></code> is optimal. A configuration which uses a larger batch size is generally ideal for batched on-demand inference or offline batch processing.</p> <p>In the following section, we compile BERT for multiple batch size inputs. We then run inference on each batch size and benchmark the performance. Notice that latency increases consistently as the batch size increases. Throughput increases as well, up until a certain point where the input size becomes too large to be efficient.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Compile BERT for different batch sizes</span> <span class="k">for</span> <span class="n">batch_size</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">10</span><span class="p">]:</span> <span class="n">tokenizer</span> <span class="o">=</span> <span class="n">AutoTokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">AutoModelForSequenceClassification</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">torchscript</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">example</span> <span class="o">=</span> <span class="n">encode</span><span class="p">(</span><span class="n">tokenizer</span><span class="p">,</span> <span class="n">sequence_0</span><span class="p">,</span> <span class="n">sequence_2</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="n">batch_size</span><span class="p">)</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example</span><span class="p">)</span> <span class="n">filename</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'model_batch_size_</span><span class="si">{</span><span class="n">batch_size</span><span class="si">}</span><span class="s1">.pt'</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> </pre></div> </div> </div> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Benchmark BERT for different batch sizes</span> <span class="k">for</span> <span class="n">batch_size</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">10</span><span class="p">]:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'-'</span><span class="o">*</span><span class="mi">50</span><span class="p">)</span> <span class="n">example</span> <span class="o">=</span> <span class="n">encode</span><span class="p">(</span><span class="n">tokenizer</span><span class="p">,</span> <span class="n">sequence_0</span><span class="p">,</span> <span class="n">sequence_2</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="n">batch_size</span><span class="p">)</span> <span class="n">filename</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'model_batch_size_</span><span class="si">{</span><span class="n">batch_size</span><span class="si">}</span><span class="s1">.pt'</span> <span class="n">benchmark</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">example</span><span class="p">)</span> <span class="nb">print</span><span class="p">()</span> </pre></div> </div> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Tutorials for Inference (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">BERT TorchServe Tutorial</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:45.379Z
BERT TorchServe Tutorial — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html
# BERT TorchServe Tutorial — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## BERT TorchServe Tutorial[#](#bert-torchserve-tutorial "Permalink to this headline") Table of Contents - [Overview](#overview) - [Run the tutorial](#run-the-tutorial) - [Setup TorchServe](#setup-torchserve) - [Run TorchServe](#run-torchserve) - [Benchmark TorchServe](#benchmark-torchserve) ## [Overview](#id6)[#](#overview "Permalink to this headline") This tutorial demonstrates the use of [TorchServe](https://pytorch.org/serve) with Neuron, the SDK for EC2 Inf2 and Trn1 instances. By the end of this tutorial, you will understand how TorchServe can be used to serve a model backed by EC2 Inf2/Trn1 instances. We will use a pretrained BERT-Base model to determine if one sentence is a paraphrase of another. ## [Run the tutorial](#id7)[#](#run-the-tutorial "Permalink to this headline") Open a terminal, log into your remote instance, and activate a Pytorch virtual environment setup (see the:ref:Install PyTorch Neuron <setup-torch-neuronx>). To complete this tutorial, you will also need a compiled BERT model. You can run [`trace_bert_neuronx.py`](../../../../../_downloads/f7973957c84ecee111dc8880b849436a/trace_bert_neuronx.py) to obtain a traced BERT model. You should now have a compiled `bert_neuron_b6.pt` file, which is required going forward. Open a shell on the instance you prepared earlier, create a new directory named `torchserve`. Copy your compiled model from the previous tutorial into this new directory. Prepare a new Python virtual environment with the necessary Neuron and TorchServe components. Use a virtual environment to keep (most of) the various tutorial components isolated from the rest of the system in a controlled way. ``` pip install transformers==4.26.0 torchserve==0.7.0 torch-model-archiver==0.7.0 captum==0.6.0 ``` Install the system requirements for TorchServe. Amazon Linux 2 DLAMI Base ``` sudo yum -y install jq java-11-amazon-corretto-headless sudo alternatives --config java sudo alternatives --config javac ``` Ubuntu 20 DLAMI Base ``` sudo apt -y install openjdk-11-jdk ``` ``` openjdk version "11.0.17" 2022-10-18 OpenJDK Runtime Environment (build 11.0.17+8-post-Ubuntu-1ubuntu218.04) OpenJDK 64-Bit Server VM (build 11.0.17+8-post-Ubuntu-1ubuntu218.04, mixed mode, sharing) ``` Verify that TorchServe is now available. ``` TorchServe Version is 0.7.0 ``` ## [Setup TorchServe](#id8)[#](#setup-torchserve "Permalink to this headline") During this tutorial you will need to download a few files onto your instance. The simplest way to accomplish this is to paste the download links provided above each file into a `wget` command. (We don’t provide the links directly because they are subject to change.) For example, right-click and copy the download link for `config.json` shown below. ``` { "model_name": "bert-base-cased-finetuned-mrpc", "max_length": 128, "batch_size": 6 } ``` Now execute the following in your shell: ``` wget <paste link here> ls ``` ``` bert_neuron_b6.pt config.json ``` Download the [custom handler script](https://pytorch.org/serve/custom_service.html) that will eventually respond to inference requests. ``` 1import os 2import json 3import sys 4import logging 5from abc import ABC 6 7import torch 8import torch_neuronx 9 10from transformers import AutoTokenizer 11from ts.torch_handler.base_handler import BaseHandler 12 13 14# one core per worker 15os.environ['NEURON_RT_NUM_CORES'] = '1' 16 17logger = logging.getLogger(__name__) 18 19class BertEmbeddingHandler(BaseHandler, ABC): 20 """ 21 Handler class for Bert Embedding computations. 22 """ 23 def __init__(self): 24 super(BertEmbeddingHandler, self).__init__() 25 self.initialized = False 26 27 def initialize(self, ctx): 28 self.manifest = ctx.manifest 29 properties = ctx.system_properties 30 self.device = 'cpu' 31 model_dir = properties.get('model_dir') 32 serialized_file = self.manifest['model']['serializedFile'] 33 model_pt_path = os.path.join(model_dir, serialized_file) 34 35 # point sys.path to our config file 36 with open('config.json') as fp: 37 config = json.load(fp) 38 self.max_length = config['max_length'] 39 self.batch_size = config['batch_size'] 40 self.classes = ['not paraphrase', 'paraphrase'] 41 42 self.model = torch.jit.load(model_pt_path) 43 logger.debug(f'Model loaded from {model_dir}') 44 self.model.to(self.device) 45 self.model.eval() 46 47 self.tokenizer = AutoTokenizer.from_pretrained(config['model_name']) 48 self.initialized = True 49 50 def preprocess(self, input_data): 51 """ 52 Tokenization pre-processing 53 """ 54 55 input_ids = [] 56 attention_masks = [] 57 token_type_ids = [] 58 for row in input_data: 59 seq_0 = row['seq_0'].decode('utf-8') 60 seq_1 = row['seq_1'].decode('utf-8') 61 logger.debug(f'Received text: "{seq_0}", "{seq_1}"') 62 63 inputs = self.tokenizer.encode_plus( 64 seq_0, 65 seq_1, 66 max_length=self.max_length, 67 padding='max_length', 68 truncation=True, 69 return_tensors='pt' 70 ) 71 72 input_ids.append(inputs['input_ids']) 73 attention_masks.append(inputs['attention_mask']) 74 token_type_ids.append(inputs['token_type_ids']) 75 76 batch = (torch.cat(input_ids, 0), 77 torch.cat(attention_masks, 0), 78 torch.cat(token_type_ids, 0)) 79 80 return batch 81 82 def inference(self, inputs): 83 """ 84 Predict the class of a text using a trained transformer model. 85 """ 86 87 # sanity check dimensions 88 assert(len(inputs) == 3) 89 num_inferences = len(inputs[0]) 90 assert(num_inferences <= self.batch_size) 91 92 # insert padding if we received a partial batch 93 padding = self.batch_size - num_inferences 94 if padding > 0: 95 pad = torch.nn.ConstantPad1d((0, 0, 0, padding), value=0) 96 inputs = [pad(x) for x in inputs] 97 98 outputs = self.model(*inputs)[0] 99 predictions = [] 100 for i in range(num_inferences): 101 prediction = self.classes[outputs[i].argmax(dim=-1).item()] 102 predictions.append([prediction]) 103 logger.debug("Model predicted: '%s'", prediction) 104 return predictions 105 106 def postprocess(self, inference_output): 107 return inference_output ``` Next, we need to associate the handler script with the compiled model using `torch-model-archiver`. Run the following commands in your terminal: ``` mkdir model_store MAX_LENGTH=$(jq '.max_length' config.json) BATCH_SIZE=$(jq '.batch_size' config.json) MODEL_NAME=bert-max_length$MAX_LENGTH-batch_size$BATCH_SIZE torch-model-archiver --model-name "$MODEL_NAME" --version 1.0 --serialized-file ./bert_neuron_b6.pt --handler "./handler_bert_neuronx.py" --extra-files "./config.json" --export-path model_store ``` Note If you modify your model or a dependency, you will need to rerun the archiver command with the `-f` flag appended to update the archive. The result of the above will be a `mar` file inside the `model_store` directory. ``` bert-max_length128-batch_size6.mar ``` This file is essentially an archive associated with a fixed version of your model along with its dependencies (e.g. the handler code). Note The version specified in the `torch-model-archiver` command can be appended to REST API requests to access a specific version of your model. For example, if your model was hosted locally on port 8080 and named “bert”, the latest version of your model would be available at `http://localhost:8080/predictions/bert`, while version 1.0 would be accessible at `http://localhost:8080/predictions/bert/1.0`. We will see how to perform inference using this API in Step 6. Create a [custom config](https://pytorch.org/serve/configuration.html) file to set some parameters. This file will be used to configure the server at launch when we run `torchserve --start`. ``` # bind inference API to all network interfaces with SSL enabled inference_address=http://0.0.0.0:8080 default_workers_per_model=1 ``` Note This will cause TorchServe to bind on all interfaces. For security in real-world applications, you’ll probably want to use port 8443 and [enable SSL](https://pytorch.org/serve/configuration.html#enable-ssl). ## [Run TorchServe](#id9)[#](#run-torchserve "Permalink to this headline") It’s time to start the server. Typically we’d want to launch this in a separate console, but for this demo we’ll just redirect output to a file. ``` torchserve --start --ncs --model-store model_store --ts-config torchserve.config 2>&1 >torchserve.log ``` Verify that the server seems to have started okay. ``` curl http://127.0.0.1:8080/ping ``` Note If you get an error when trying to ping the server, you may have tried before the server was fully launched. Check `torchserve.log` for details. Use the Management API to instruct TorchServe to load our model. First, determine the number of NeuronCores available based on your instance size. Inf2 | Instance Size | \# of NeuronCores | | --- | --- | | xlarge | 2 | | 8xlarge | 2 | | 24xlarge | 12 | | 48xlarge | 24 | Trn1 | Instance Size | \# of NeuronCores | | --- | --- | | 2xlarge | 2 | | 32xlarge | 32 | ``` MAX_BATCH_DELAY=5000 # ms timeout before a partial batch is processed INITIAL_WORKERS=<number of NeuronCores from table above> curl -X POST "http://localhost:8081/models?url=$MODEL_NAME.mar&batch_size=$BATCH_SIZE&initial_workers=$INITIAL_WORKERS&max_batch_delay=$MAX_BATCH_DELAY" ``` ``` { "status": "Model \"bert-max_length128-batch_size6\" Version: 1.0 registered with X initial workers" } ``` Warning You shouldn’t set `INITIAL_WORKERS` above the number of NeuronCores. If you attempt to load more models than NeuronCores available, one of two things will occur. Either the extra models will fit in device memory but performance will suffer, or you will encounter an error on your initial inference. However, you may want to use fewer cores if you are using the [NeuronCore Pipeline](../../../../../general/arch/neuron-features/neuroncore-pipeline.html#neuroncore-pipeline) feature. Note Any additional attempts to configure the model after the initial curl request will cause the server to return a 409 error. You’ll need to stop/start/configure the server to realize any changes. The `MAX_BATCH_DELAY` is a timeout value that determines how long to wait before processing a partial batch. This is why the handler code needs to check the batch dimension and potentially add padding. TorchServe will instantiate the number of model handlers indicated by `INITIAL_WORKERS`, so this value controls how many models we will load onto Inferentia in parallel. If you want to control worker scaling more dynamically, [see the docs](https://pytorch.org/serve/management_api.html#scale-workers). It looks like everything is running successfully at this point, so it’s time for an inference. Create the `infer_bert.py` file below on your instance. ``` 1import json 2import concurrent.futures 3import requests 4 5with open('config.json') as fp: 6 config = json.load(fp) 7max_length = config['max_length'] 8batch_size = config['batch_size'] 9name = f'bert-max_length{max_length}-batch_size{batch_size}' 10 11# dispatch requests in parallel 12url = f'http://localhost:8080/predictions/{name}' 13paraphrase = {'seq_0': "HuggingFace's headquarters are situated in Manhattan", 14 'seq_1': "The company HuggingFace is based in New York City"} 15not_paraphrase = {'seq_0': paraphrase['seq_0'], 'seq_1': 'This is total nonsense.'} 16 17with concurrent.futures.ThreadPoolExecutor(max_workers=batch_size) as executor: 18 def worker_thread(worker_index): 19 # we'll send half the requests as not_paraphrase examples for sanity 20 data = paraphrase if worker_index < batch_size//2 else not_paraphrase 21 response = requests.post(url, data=data) 22 print(worker_index, response.json()) 23 24 for worker_index in range(batch_size): 25 executor.submit(worker_thread, worker_index) ``` This script will send a `batch_size` number of requests to our model. In this example, we are using a model that estimates the probability that one sentence is a paraphrase of another. The script sends positive examples in the first half of the batch and negative examples in the second half. Execute the script in your terminal. ``` 1 ['paraphrase'] 3 ['not paraphrase'] 4 ['not paraphrase'] 0 ['paraphrase'] 5 ['not paraphrase'] 2 ['paraphrase'] ``` We can see that the first three threads (0, 1, 2) all report `paraphrase`, as expected. If we instead modify the script to send an incomplete batch and then wait for the timeout to expire, the excess padding results will be discarded. ## [Benchmark TorchServe](#id10)[#](#benchmark-torchserve "Permalink to this headline") We’ve seen how to perform a single batched inference, but how many inferences can we process per second? A separate upcoming tutorial will document performance tuning to maximize throughput. In the meantime, we can still perform a simple naïve stress test. The code below will spawn 64 worker threads, with each thread repeatedly sending a full batch of data to process. A separate thread will periodically print throughput and latency measurements. ``` 1import os 2import argparse 3import time 4import numpy as np 5import requests 6import sys 7from concurrent import futures 8 9import torch 10 11 12parser = argparse.ArgumentParser() 13parser.add_argument('--url', help='Torchserve model URL', type=str, default=f'http://127.0.0.1:8080/predictions/bert-max_length128-batch_size6') 14parser.add_argument('--num_thread', type=int, default=64, help='Number of threads invoking the model URL') 15parser.add_argument('--batch_size', type=int, default=6) 16parser.add_argument('--sequence_length', type=int, default=128) 17parser.add_argument('--latency_window_size', type=int, default=1000) 18parser.add_argument('--throughput_time', type=int, default=300) 19parser.add_argument('--throughput_interval', type=int, default=10) 20args = parser.parse_args() 21 22data = { 'seq_0': 'A completely made up sentence.', 23 'seq_1': 'Well, I suppose they are all made up.' } 24live = True 25num_infer = 0 26latency_list = [] 27 28 29def one_thread(pred, feed_data): 30 global latency_list 31 global num_infer 32 global live 33 session = requests.Session() 34 while True: 35 start = time.time() 36 result = session.post(pred, data=feed_data) 37 latency = time.time() - start 38 latency_list.append(latency) 39 num_infer += 1 40 if not live: 41 break 42 43 44def current_performance(): 45 last_num_infer = num_infer 46 for _ in range(args.throughput_time // args.throughput_interval): 47 current_num_infer = num_infer 48 throughput = (current_num_infer - last_num_infer) / args.throughput_interval 49 p50 = 0.0 50 p90 = 0.0 51 if latency_list: 52 p50 = np.percentile(latency_list[-args.latency_window_size:], 50) 53 p90 = np.percentile(latency_list[-args.latency_window_size:], 90) 54 print('pid {}: current throughput {}, latency p50={:.3f} p90={:.3f}'.format(os.getpid(), throughput, p50, p90)) 55 sys.stdout.flush() 56 last_num_infer = current_num_infer 57 time.sleep(args.throughput_interval) 58 global live 59 live = False 60 61 62with futures.ThreadPoolExecutor(max_workers=args.num_thread+1) as executor: 63 executor.submit(current_performance) 64 for _ in range(args.num_thread): 65 executor.submit(one_thread, args.url, data) ``` Run the benchmarking script. ``` pid 1214554: current throughput 0.0, latency p50=0.000 p90=0.000 pid 1214554: current throughput 713.9, latency p50=0.071 p90=0.184 pid 1214554: current throughput 737.9, latency p50=0.071 p90=0.184 pid 1214554: current throughput 731.6, latency p50=0.068 p90=0.192 pid 1214554: current throughput 732.2, latency p50=0.070 p90=0.194 pid 1214554: current throughput 733.9, latency p50=0.070 p90=0.187 pid 1214554: current throughput 739.3, latency p50=0.071 p90=0.184 ... ``` Note Your throughput numbers may differ from these based on instance type and size. **Congratulations!** By now you should have successfully served a batched model over TorchServe. You can now shutdown torchserve. _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>BERT TorchServe Tutorial — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="LibTorch C++ Tutorial" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> <link rel="prev" title="Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#overview"> Overview </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#run-the-tutorial"> Run the tutorial </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-torchserve"> Setup TorchServe </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#run-torchserve"> Run TorchServe </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#benchmark-torchserve"> Benchmark TorchServe </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>BERT TorchServe Tutorial</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#overview"> Overview </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#run-the-tutorial"> Run the tutorial </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-torchserve"> Setup TorchServe </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#run-torchserve"> Run TorchServe </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#benchmark-torchserve"> Benchmark TorchServe </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="bert-torchserve-tutorial"> <span id="pytorch-tutorials-torchserve-neuronx"></span><h1>BERT TorchServe Tutorial<a class="headerlink" href="#bert-torchserve-tutorial" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#overview" id="id6">Overview</a></p></li> <li><p><a class="reference internal" href="#run-the-tutorial" id="id7">Run the tutorial</a></p></li> <li><p><a class="reference internal" href="#setup-torchserve" id="id8">Setup TorchServe</a></p></li> <li><p><a class="reference internal" href="#run-torchserve" id="id9">Run TorchServe</a></p></li> <li><p><a class="reference internal" href="#benchmark-torchserve" id="id10">Benchmark TorchServe</a></p></li> </ul> </div> <div class="section" id="overview"> <h2><a class="toc-backref" href="#id6">Overview</a><a class="headerlink" href="#overview" title="Permalink to this headline">#</a></h2> <p>This tutorial demonstrates the use of <a class="reference external" href="https://pytorch.org/serve">TorchServe</a> with Neuron, the SDK for EC2 Inf2 and Trn1 instances. By the end of this tutorial, you will understand how TorchServe can be used to serve a model backed by EC2 Inf2/Trn1 instances. We will use a pretrained BERT-Base model to determine if one sentence is a paraphrase of another.</p> </div> <div class="section" id="run-the-tutorial"> <span id="torchserve-compile"></span><h2><a class="toc-backref" href="#id7">Run the tutorial</a><a class="headerlink" href="#run-the-tutorial" title="Permalink to this headline">#</a></h2> <p>Open a terminal, log into your remote instance, and activate a Pytorch virtual environment setup (see the:ref:<cite>Install PyTorch Neuron &lt;setup-torch-neuronx&gt;</cite>). To complete this tutorial, you will also need a compiled BERT model. You can run <a class="reference download internal" download="" href="../../../../../_downloads/f7973957c84ecee111dc8880b849436a/trace_bert_neuronx.py"><code class="xref download docutils literal notranslate"><span class="pre">trace_bert_neuronx.py</span></code></a> to obtain a traced BERT model.</p> <p>You should now have a compiled <code class="docutils literal notranslate"><span class="pre">bert_neuron_b6.pt</span></code> file, which is required going forward.</p> <p>Open a shell on the instance you prepared earlier, create a new directory named <code class="docutils literal notranslate"><span class="pre">torchserve</span></code>. Copy your compiled model from the previous tutorial into this new directory.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>torchserve ls </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bert_neuron_b6</span><span class="o">.</span><span class="n">pt</span> </pre></div> </div> <p>Prepare a new Python virtual environment with the necessary Neuron and TorchServe components. Use a virtual environment to keep (most of) the various tutorial components isolated from the rest of the system in a controlled way.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span><span class="nv">transformers</span><span class="o">==</span><span class="m">4</span>.26.0<span class="w"> </span><span class="nv">torchserve</span><span class="o">==</span><span class="m">0</span>.7.0<span class="w"> </span>torch-model-archiver<span class="o">==</span><span class="m">0</span>.7.0<span class="w"> </span><span class="nv">captum</span><span class="o">==</span><span class="m">0</span>.6.0 </pre></div> </div> <p>Install the system requirements for TorchServe.</p> <div class="sd-tab-set docutils"> <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-0"> Amazon Linux 2 DLAMI Base</label><div class="sd-tab-content docutils"> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>yum<span class="w"> </span>-y<span class="w"> </span>install<span class="w"> </span>jq<span class="w"> </span>java-11-amazon-corretto-headless sudo<span class="w"> </span>alternatives<span class="w"> </span>--config<span class="w"> </span>java sudo<span class="w"> </span>alternatives<span class="w"> </span>--config<span class="w"> </span>javac </pre></div> </div> </div> <input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-1"> Ubuntu 20 DLAMI Base</label><div class="sd-tab-content docutils"> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>-y<span class="w"> </span>install<span class="w"> </span>openjdk-11-jdk </pre></div> </div> </div> </div> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>java<span class="w"> </span>-version </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">openjdk</span> <span class="n">version</span> <span class="s2">"11.0.17"</span> <span class="mi">2022</span><span class="o">-</span><span class="mi">10</span><span class="o">-</span><span class="mi">18</span> <span class="n">OpenJDK</span> <span class="n">Runtime</span> <span class="n">Environment</span> <span class="p">(</span><span class="n">build</span> <span class="mf">11.0.17</span><span class="o">+</span><span class="mi">8</span><span class="o">-</span><span class="n">post</span><span class="o">-</span><span class="n">Ubuntu</span><span class="o">-</span><span class="mi">1</span><span class="n">ubuntu218</span><span class="mf">.04</span><span class="p">)</span> <span class="n">OpenJDK</span> <span class="mi">64</span><span class="o">-</span><span class="n">Bit</span> <span class="n">Server</span> <span class="n">VM</span> <span class="p">(</span><span class="n">build</span> <span class="mf">11.0.17</span><span class="o">+</span><span class="mi">8</span><span class="o">-</span><span class="n">post</span><span class="o">-</span><span class="n">Ubuntu</span><span class="o">-</span><span class="mi">1</span><span class="n">ubuntu218</span><span class="mf">.04</span><span class="p">,</span> <span class="n">mixed</span> <span class="n">mode</span><span class="p">,</span> <span class="n">sharing</span><span class="p">)</span> </pre></div> </div> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>javac<span class="w"> </span>-version </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">javac</span> <span class="mf">11.0.17</span> </pre></div> </div> <p>Verify that TorchServe is now available.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>torchserve<span class="w"> </span>--version </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">TorchServe</span> <span class="n">Version</span> <span class="ow">is</span> <span class="mf">0.7.0</span> </pre></div> </div> </div> <div class="section" id="setup-torchserve"> <span id="torchserve-setup"></span><h2><a class="toc-backref" href="#id8">Setup TorchServe</a><a class="headerlink" href="#setup-torchserve" title="Permalink to this headline">#</a></h2> <p>During this tutorial you will need to download a few files onto your instance. The simplest way to accomplish this is to paste the download links provided above each file into a <code class="docutils literal notranslate"><span class="pre">wget</span></code> command. (We don’t provide the links directly because they are subject to change.) For example, right-click and copy the download link for <code class="docutils literal notranslate"><span class="pre">config.json</span></code> shown below.</p> <div class="literal-block-wrapper docutils container" id="id1"> <div class="code-block-caption"><span class="caption-text"><a class="reference download internal" download="" href="../../../../../_downloads/cbeed28d83ac18dfc474cca0e8fd46bd/config.json"><code class="xref download docutils literal notranslate"><span class="pre">config.json</span></code></a></span><a class="headerlink" href="#id1" title="Permalink to this code">#</a></div> <div class="highlight-JSON notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="nt">"model_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bert-base-cased-finetuned-mrpc"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"max_length"</span><span class="p">:</span><span class="w"> </span><span class="mi">128</span><span class="p">,</span> <span class="w"> </span><span class="nt">"batch_size"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span> <span class="p">}</span> </pre></div> </div> </div> <p>Now execute the following in your shell:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>wget<span class="w"> </span>&lt;paste<span class="w"> </span>link<span class="w"> </span>here&gt; ls </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bert_neuron_b6</span><span class="o">.</span><span class="n">pt</span> <span class="n">config</span><span class="o">.</span><span class="n">json</span> </pre></div> </div> <p>Download the <a class="reference external" href="https://pytorch.org/serve/custom_service.html">custom handler script</a> that will eventually respond to inference requests.</p> <div class="literal-block-wrapper docutils container" id="id2"> <div class="code-block-caption"><span class="caption-text"><a class="reference download internal" download="" href="../../../../../_downloads/91e5622a3cf52716e37777b5581e6655/handler_bert_neuronx.py"><code class="xref download docutils literal notranslate"><span class="pre">handler_bert_neuronx.py</span></code></a></span><a class="headerlink" href="#id2" title="Permalink to this code">#</a></div> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kn">import</span> <span class="nn">os</span> <span class="linenos"> 2</span><span class="kn">import</span> <span class="nn">json</span> <span class="linenos"> 3</span><span class="kn">import</span> <span class="nn">sys</span> <span class="linenos"> 4</span><span class="kn">import</span> <span class="nn">logging</span> <span class="linenos"> 5</span><span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABC</span> <span class="linenos"> 6</span> <span class="linenos"> 7</span><span class="kn">import</span> <span class="nn">torch</span> <span class="linenos"> 8</span><span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="linenos"> 9</span> <span class="linenos"> 10</span><span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">AutoTokenizer</span> <span class="linenos"> 11</span><span class="kn">from</span> <span class="nn">ts.torch_handler.base_handler</span> <span class="kn">import</span> <span class="n">BaseHandler</span> <span class="linenos"> 12</span> <span class="linenos"> 13</span> <span class="linenos"> 14</span><span class="c1"># one core per worker</span> <span class="linenos"> 15</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_RT_NUM_CORES'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'1'</span> <span class="linenos"> 16</span> <span class="linenos"> 17</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span> <span class="linenos"> 18</span> <span class="linenos"> 19</span><span class="k">class</span> <span class="nc">BertEmbeddingHandler</span><span class="p">(</span><span class="n">BaseHandler</span><span class="p">,</span> <span class="n">ABC</span><span class="p">):</span> <span class="linenos"> 20</span><span class="w"> </span><span class="sd">"""</span> <span class="linenos"> 21</span><span class="sd"> Handler class for Bert Embedding computations.</span> <span class="linenos"> 22</span><span class="sd"> """</span> <span class="linenos"> 23</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="linenos"> 24</span> <span class="nb">super</span><span class="p">(</span><span class="n">BertEmbeddingHandler</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="linenos"> 25</span> <span class="bp">self</span><span class="o">.</span><span class="n">initialized</span> <span class="o">=</span> <span class="kc">False</span> <span class="linenos"> 26</span> <span class="linenos"> 27</span> <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span> <span class="linenos"> 28</span> <span class="bp">self</span><span class="o">.</span><span class="n">manifest</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">manifest</span> <span class="linenos"> 29</span> <span class="n">properties</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">system_properties</span> <span class="linenos"> 30</span> <span class="bp">self</span><span class="o">.</span><span class="n">device</span> <span class="o">=</span> <span class="s1">'cpu'</span> <span class="linenos"> 31</span> <span class="n">model_dir</span> <span class="o">=</span> <span class="n">properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'model_dir'</span><span class="p">)</span> <span class="linenos"> 32</span> <span class="n">serialized_file</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">manifest</span><span class="p">[</span><span class="s1">'model'</span><span class="p">][</span><span class="s1">'serializedFile'</span><span class="p">]</span> <span class="linenos"> 33</span> <span class="n">model_pt_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">model_dir</span><span class="p">,</span> <span class="n">serialized_file</span><span class="p">)</span> <span class="linenos"> 34</span> <span class="linenos"> 35</span> <span class="c1"># point sys.path to our config file</span> <span class="linenos"> 36</span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'config.json'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span> <span class="linenos"> 37</span> <span class="n">config</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">fp</span><span class="p">)</span> <span class="linenos"> 38</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_length</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="s1">'max_length'</span><span class="p">]</span> <span class="linenos"> 39</span> <span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="s1">'batch_size'</span><span class="p">]</span> <span class="linenos"> 40</span> <span class="bp">self</span><span class="o">.</span><span class="n">classes</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'not paraphrase'</span><span class="p">,</span> <span class="s1">'paraphrase'</span><span class="p">]</span> <span class="linenos"> 41</span> <span class="linenos"> 42</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">model_pt_path</span><span class="p">)</span> <span class="linenos"> 43</span> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Model loaded from </span><span class="si">{</span><span class="n">model_dir</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span> <span class="linenos"> 44</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">device</span><span class="p">)</span> <span class="linenos"> 45</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="linenos"> 46</span> <span class="linenos"> 47</span> <span class="bp">self</span><span class="o">.</span><span class="n">tokenizer</span> <span class="o">=</span> <span class="n">AutoTokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">config</span><span class="p">[</span><span class="s1">'model_name'</span><span class="p">])</span> <span class="linenos"> 48</span> <span class="bp">self</span><span class="o">.</span><span class="n">initialized</span> <span class="o">=</span> <span class="kc">True</span> <span class="linenos"> 49</span> <span class="linenos"> 50</span> <span class="k">def</span> <span class="nf">preprocess</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">input_data</span><span class="p">):</span> <span class="linenos"> 51</span><span class="w"> </span><span class="sd">"""</span> <span class="linenos"> 52</span><span class="sd"> Tokenization pre-processing</span> <span class="linenos"> 53</span><span class="sd"> """</span> <span class="linenos"> 54</span> <span class="linenos"> 55</span> <span class="n">input_ids</span> <span class="o">=</span> <span class="p">[]</span> <span class="linenos"> 56</span> <span class="n">attention_masks</span> <span class="o">=</span> <span class="p">[]</span> <span class="linenos"> 57</span> <span class="n">token_type_ids</span> <span class="o">=</span> <span class="p">[]</span> <span class="linenos"> 58</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">input_data</span><span class="p">:</span> <span class="linenos"> 59</span> <span class="n">seq_0</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="s1">'seq_0'</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span> <span class="linenos"> 60</span> <span class="n">seq_1</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="s1">'seq_1'</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span> <span class="linenos"> 61</span> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Received text: "</span><span class="si">{</span><span class="n">seq_0</span><span class="si">}</span><span class="s1">", "</span><span class="si">{</span><span class="n">seq_1</span><span class="si">}</span><span class="s1">"'</span><span class="p">)</span> <span class="linenos"> 62</span> <span class="linenos"> 63</span> <span class="n">inputs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tokenizer</span><span class="o">.</span><span class="n">encode_plus</span><span class="p">(</span> <span class="linenos"> 64</span> <span class="n">seq_0</span><span class="p">,</span> <span class="linenos"> 65</span> <span class="n">seq_1</span><span class="p">,</span> <span class="linenos"> 66</span> <span class="n">max_length</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">max_length</span><span class="p">,</span> <span class="linenos"> 67</span> <span class="n">padding</span><span class="o">=</span><span class="s1">'max_length'</span><span class="p">,</span> <span class="linenos"> 68</span> <span class="n">truncation</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="linenos"> 69</span> <span class="n">return_tensors</span><span class="o">=</span><span class="s1">'pt'</span> <span class="linenos"> 70</span> <span class="p">)</span> <span class="linenos"> 71</span> <span class="linenos"> 72</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">inputs</span><span class="p">[</span><span class="s1">'input_ids'</span><span class="p">])</span> <span class="linenos"> 73</span> <span class="n">attention_masks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">inputs</span><span class="p">[</span><span class="s1">'attention_mask'</span><span class="p">])</span> <span class="linenos"> 74</span> <span class="n">token_type_ids</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">inputs</span><span class="p">[</span><span class="s1">'token_type_ids'</span><span class="p">])</span> <span class="linenos"> 75</span> <span class="linenos"> 76</span> <span class="n">batch</span> <span class="o">=</span> <span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">(</span><span class="n">input_ids</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="linenos"> 77</span> <span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">(</span><span class="n">attention_masks</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="linenos"> 78</span> <span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">(</span><span class="n">token_type_ids</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span> <span class="linenos"> 79</span> <span class="linenos"> 80</span> <span class="k">return</span> <span class="n">batch</span> <span class="linenos"> 81</span> <span class="linenos"> 82</span> <span class="k">def</span> <span class="nf">inference</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inputs</span><span class="p">):</span> <span class="linenos"> 83</span><span class="w"> </span><span class="sd">"""</span> <span class="linenos"> 84</span><span class="sd"> Predict the class of a text using a trained transformer model.</span> <span class="linenos"> 85</span><span class="sd"> """</span> <span class="linenos"> 86</span> <span class="linenos"> 87</span> <span class="c1"># sanity check dimensions</span> <span class="linenos"> 88</span> <span class="k">assert</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">inputs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span><span class="p">)</span> <span class="linenos"> 89</span> <span class="n">num_inferences</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">inputs</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="linenos"> 90</span> <span class="k">assert</span><span class="p">(</span><span class="n">num_inferences</span> <span class="o">&lt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span><span class="p">)</span> <span class="linenos"> 91</span> <span class="linenos"> 92</span> <span class="c1"># insert padding if we received a partial batch</span> <span class="linenos"> 93</span> <span class="n">padding</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span> <span class="o">-</span> <span class="n">num_inferences</span> <span class="linenos"> 94</span> <span class="k">if</span> <span class="n">padding</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span> <span class="linenos"> 95</span> <span class="n">pad</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">ConstantPad1d</span><span class="p">((</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">padding</span><span class="p">),</span> <span class="n">value</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="linenos"> 96</span> <span class="n">inputs</span> <span class="o">=</span> <span class="p">[</span><span class="n">pad</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">inputs</span><span class="p">]</span> <span class="linenos"> 97</span> <span class="linenos"> 98</span> <span class="n">outputs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">(</span><span class="o">*</span><span class="n">inputs</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="linenos"> 99</span> <span class="n">predictions</span> <span class="o">=</span> <span class="p">[]</span> <span class="linenos">100</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_inferences</span><span class="p">):</span> <span class="linenos">101</span> <span class="n">prediction</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="p">[</span><span class="n">outputs</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">argmax</span><span class="p">(</span><span class="n">dim</span><span class="o">=-</span><span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">item</span><span class="p">()]</span> <span class="linenos">102</span> <span class="n">predictions</span><span class="o">.</span><span class="n">append</span><span class="p">([</span><span class="n">prediction</span><span class="p">])</span> <span class="linenos">103</span> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Model predicted: '</span><span class="si">%s</span><span class="s2">'"</span><span class="p">,</span> <span class="n">prediction</span><span class="p">)</span> <span class="linenos">104</span> <span class="k">return</span> <span class="n">predictions</span> <span class="linenos">105</span> <span class="linenos">106</span> <span class="k">def</span> <span class="nf">postprocess</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inference_output</span><span class="p">):</span> <span class="linenos">107</span> <span class="k">return</span> <span class="n">inference_output</span> </pre></div> </div> </div> <p>Next, we need to associate the handler script with the compiled model using <code class="docutils literal notranslate"><span class="pre">torch-model-archiver</span></code>. Run the following commands in your terminal:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mkdir<span class="w"> </span>model_store <span class="nv">MAX_LENGTH</span><span class="o">=</span><span class="k">$(</span>jq<span class="w"> </span><span class="s1">'.max_length'</span><span class="w"> </span>config.json<span class="k">)</span> <span class="nv">BATCH_SIZE</span><span class="o">=</span><span class="k">$(</span>jq<span class="w"> </span><span class="s1">'.batch_size'</span><span class="w"> </span>config.json<span class="k">)</span> <span class="nv">MODEL_NAME</span><span class="o">=</span>bert-max_length<span class="nv">$MAX_LENGTH</span>-batch_size<span class="nv">$BATCH_SIZE</span> torch-model-archiver<span class="w"> </span>--model-name<span class="w"> </span><span class="s2">"</span><span class="nv">$MODEL_NAME</span><span class="s2">"</span><span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.0<span class="w"> </span>--serialized-file<span class="w"> </span>./bert_neuron_b6.pt<span class="w"> </span>--handler<span class="w"> </span><span class="s2">"./handler_bert_neuronx.py"</span><span class="w"> </span>--extra-files<span class="w"> </span><span class="s2">"./config.json"</span><span class="w"> </span>--export-path<span class="w"> </span>model_store </pre></div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>If you modify your model or a dependency, you will need to rerun the archiver command with the <code class="docutils literal notranslate"><span class="pre">-f</span></code> flag appended to update the archive.</p> </div> <p>The result of the above will be a <code class="docutils literal notranslate"><span class="pre">mar</span></code> file inside the <code class="docutils literal notranslate"><span class="pre">model_store</span></code> directory.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>ls<span class="w"> </span>model_store </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bert</span><span class="o">-</span><span class="n">max_length128</span><span class="o">-</span><span class="n">batch_size6</span><span class="o">.</span><span class="n">mar</span> </pre></div> </div> <p>This file is essentially an archive associated with a fixed version of your model along with its dependencies (e.g. the handler code).</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The version specified in the <code class="docutils literal notranslate"><span class="pre">torch-model-archiver</span></code> command can be appended to REST API requests to access a specific version of your model. For example, if your model was hosted locally on port 8080 and named “bert”, the latest version of your model would be available at <code class="docutils literal notranslate"><span class="pre">http://localhost:8080/predictions/bert</span></code>, while version 1.0 would be accessible at <code class="docutils literal notranslate"><span class="pre">http://localhost:8080/predictions/bert/1.0</span></code>. We will see how to perform inference using this API in Step 6.</p> </div> <p>Create a <a class="reference external" href="https://pytorch.org/serve/configuration.html">custom config</a> file to set some parameters. This file will be used to configure the server at launch when we run <code class="docutils literal notranslate"><span class="pre">torchserve</span> <span class="pre">--start</span></code>.</p> <div class="literal-block-wrapper docutils container" id="id3"> <div class="code-block-caption"><span class="caption-text"><a class="reference download internal" download="" href="../../../../../_downloads/47f3a2a02c39985f3510bf499227b636/torchserve.config"><code class="xref download docutils literal notranslate"><span class="pre">torchserve.config</span></code></a></span><a class="headerlink" href="#id3" title="Permalink to this code">#</a></div> <div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="c1"># bind inference API to all network interfaces with SSL enabled</span> <span class="na">inference_address</span><span class="o">=</span><span class="s">http://0.0.0.0:8080</span> <span class="na">default_workers_per_model</span><span class="o">=</span><span class="s">1</span> </pre></div> </div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>This will cause TorchServe to bind on all interfaces. For security in real-world applications, you’ll probably want to use port 8443 and <a class="reference external" href="https://pytorch.org/serve/configuration.html#enable-ssl">enable SSL</a>.</p> </div> </div> <div class="section" id="run-torchserve"> <span id="torchserve-run"></span><h2><a class="toc-backref" href="#id9">Run TorchServe</a><a class="headerlink" href="#run-torchserve" title="Permalink to this headline">#</a></h2> <p>It’s time to start the server. Typically we’d want to launch this in a separate console, but for this demo we’ll just redirect output to a file.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>torchserve<span class="w"> </span>--start<span class="w"> </span>--ncs<span class="w"> </span>--model-store<span class="w"> </span>model_store<span class="w"> </span>--ts-config<span class="w"> </span>torchserve.config<span class="w"> </span><span class="m">2</span>&gt;<span class="p">&amp;</span><span class="m">1</span><span class="w"> </span>&gt;torchserve.log </pre></div> </div> <p>Verify that the server seems to have started okay.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>http://127.0.0.1:8080/ping </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"Healthy"</span> <span class="p">}</span> </pre></div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>If you get an error when trying to ping the server, you may have tried before the server was fully launched. Check <code class="docutils literal notranslate"><span class="pre">torchserve.log</span></code> for details.</p> </div> <p>Use the Management API to instruct TorchServe to load our model.</p> <p>First, determine the number of NeuronCores available based on your instance size.</p> <div class="sd-tab-set docutils"> <input checked="checked" id="sd-tab-item-2" name="sd-tab-set-1" type="radio"> <label class="sd-tab-label" for="sd-tab-item-2"> Inf2</label><div class="sd-tab-content docutils"> <table class="table"> <colgroup> <col style="width: 50%"> <col style="width: 50%"> </colgroup> <thead> <tr class="row-odd"><th class="head"><p>Instance Size</p></th> <th class="head"><p># of NeuronCores</p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p>xlarge</p></td> <td><p>2</p></td> </tr> <tr class="row-odd"><td><p>8xlarge</p></td> <td><p>2</p></td> </tr> <tr class="row-even"><td><p>24xlarge</p></td> <td><p>12</p></td> </tr> <tr class="row-odd"><td><p>48xlarge</p></td> <td><p>24</p></td> </tr> </tbody> </table> </div> <input id="sd-tab-item-3" name="sd-tab-set-1" type="radio"> <label class="sd-tab-label" for="sd-tab-item-3"> Trn1</label><div class="sd-tab-content docutils"> <table class="table"> <colgroup> <col style="width: 50%"> <col style="width: 50%"> </colgroup> <thead> <tr class="row-odd"><th class="head"><p>Instance Size</p></th> <th class="head"><p># of NeuronCores</p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p>2xlarge</p></td> <td><p>2</p></td> </tr> <tr class="row-odd"><td><p>32xlarge</p></td> <td><p>32</p></td> </tr> </tbody> </table> </div> </div> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">MAX_BATCH_DELAY</span><span class="o">=</span><span class="m">5000</span><span class="w"> </span><span class="c1"># ms timeout before a partial batch is processed</span> <span class="nv">INITIAL_WORKERS</span><span class="o">=</span>&lt;number<span class="w"> </span>of<span class="w"> </span>NeuronCores<span class="w"> </span>from<span class="w"> </span>table<span class="w"> </span>above&gt; curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"http://localhost:8081/models?url=</span><span class="nv">$MODEL_NAME</span><span class="s2">.mar&amp;batch_size=</span><span class="nv">$BATCH_SIZE</span><span class="s2">&amp;initial_workers=</span><span class="nv">$INITIAL_WORKERS</span><span class="s2">&amp;max_batch_delay=</span><span class="nv">$MAX_BATCH_DELAY</span><span class="s2">"</span> </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"Model </span><span class="se">\"</span><span class="s2">bert-max_length128-batch_size6</span><span class="se">\"</span><span class="s2"> Version: 1.0 registered with X initial workers"</span> <span class="p">}</span> </pre></div> </div> <div class="admonition warning"> <p class="admonition-title">Warning</p> <p>You shouldn’t set <code class="docutils literal notranslate"><span class="pre">INITIAL_WORKERS</span></code> above the number of NeuronCores. If you attempt to load more models than NeuronCores available, one of two things will occur. Either the extra models will fit in device memory but performance will suffer, or you will encounter an error on your initial inference. However, you may want to use fewer cores if you are using the <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html#neuroncore-pipeline"><span class="std std-ref">NeuronCore Pipeline</span></a> feature.</p> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Any additional attempts to configure the model after the initial curl request will cause the server to return a 409 error. You’ll need to stop/start/configure the server to realize any changes.</p> </div> <p>The <code class="docutils literal notranslate"><span class="pre">MAX_BATCH_DELAY</span></code> is a timeout value that determines how long to wait before processing a partial batch. This is why the handler code needs to check the batch dimension and potentially add padding. TorchServe will instantiate the number of model handlers indicated by <code class="docutils literal notranslate"><span class="pre">INITIAL_WORKERS</span></code>, so this value controls how many models we will load onto Inferentia in parallel. If you want to control worker scaling more dynamically, <a class="reference external" href="https://pytorch.org/serve/management_api.html#scale-workers">see the docs</a>.</p> <p>It looks like everything is running successfully at this point, so it’s time for an inference.</p> <p>Create the <code class="docutils literal notranslate"><span class="pre">infer_bert.py</span></code> file below on your instance.</p> <div class="literal-block-wrapper docutils container" id="id4"> <div class="code-block-caption"><span class="caption-text"><a class="reference download internal" download="" href="../../../../../_downloads/e013b46f861cc3cf3ca2fd5978537bd0/infer_bert.py"><code class="xref download docutils literal notranslate"><span class="pre">infer_bert.py</span></code></a></span><a class="headerlink" href="#id4" title="Permalink to this code">#</a></div> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kn">import</span> <span class="nn">json</span> <span class="linenos"> 2</span><span class="kn">import</span> <span class="nn">concurrent.futures</span> <span class="linenos"> 3</span><span class="kn">import</span> <span class="nn">requests</span> <span class="linenos"> 4</span> <span class="linenos"> 5</span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'config.json'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span> <span class="linenos"> 6</span> <span class="n">config</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">fp</span><span class="p">)</span> <span class="linenos"> 7</span><span class="n">max_length</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="s1">'max_length'</span><span class="p">]</span> <span class="linenos"> 8</span><span class="n">batch_size</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="s1">'batch_size'</span><span class="p">]</span> <span class="linenos"> 9</span><span class="n">name</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'bert-max_length</span><span class="si">{</span><span class="n">max_length</span><span class="si">}</span><span class="s1">-batch_size</span><span class="si">{</span><span class="n">batch_size</span><span class="si">}</span><span class="s1">'</span> <span class="linenos">10</span> <span class="linenos">11</span><span class="c1"># dispatch requests in parallel</span> <span class="linenos">12</span><span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'http://localhost:8080/predictions/</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s1">'</span> <span class="linenos">13</span><span class="n">paraphrase</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'seq_0'</span><span class="p">:</span> <span class="s2">"HuggingFace's headquarters are situated in Manhattan"</span><span class="p">,</span> <span class="linenos">14</span> <span class="s1">'seq_1'</span><span class="p">:</span> <span class="s2">"The company HuggingFace is based in New York City"</span><span class="p">}</span> <span class="linenos">15</span><span class="n">not_paraphrase</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'seq_0'</span><span class="p">:</span> <span class="n">paraphrase</span><span class="p">[</span><span class="s1">'seq_0'</span><span class="p">],</span> <span class="s1">'seq_1'</span><span class="p">:</span> <span class="s1">'This is total nonsense.'</span><span class="p">}</span> <span class="linenos">16</span> <span class="linenos">17</span><span class="k">with</span> <span class="n">concurrent</span><span class="o">.</span><span class="n">futures</span><span class="o">.</span><span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="n">batch_size</span><span class="p">)</span> <span class="k">as</span> <span class="n">executor</span><span class="p">:</span> <span class="linenos">18</span> <span class="k">def</span> <span class="nf">worker_thread</span><span class="p">(</span><span class="n">worker_index</span><span class="p">):</span> <span class="linenos">19</span> <span class="c1"># we'll send half the requests as not_paraphrase examples for sanity</span> <span class="linenos">20</span> <span class="n">data</span> <span class="o">=</span> <span class="n">paraphrase</span> <span class="k">if</span> <span class="n">worker_index</span> <span class="o">&lt;</span> <span class="n">batch_size</span><span class="o">//</span><span class="mi">2</span> <span class="k">else</span> <span class="n">not_paraphrase</span> <span class="linenos">21</span> <span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span> <span class="linenos">22</span> <span class="nb">print</span><span class="p">(</span><span class="n">worker_index</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span> <span class="linenos">23</span> <span class="linenos">24</span> <span class="k">for</span> <span class="n">worker_index</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">batch_size</span><span class="p">):</span> <span class="linenos">25</span> <span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">worker_thread</span><span class="p">,</span> <span class="n">worker_index</span><span class="p">)</span> </pre></div> </div> </div> <p>This script will send a <code class="docutils literal notranslate"><span class="pre">batch_size</span></code> number of requests to our model. In this example, we are using a model that estimates the probability that one sentence is a paraphrase of another. The script sends positive examples in the first half of the batch and negative examples in the second half.</p> <p>Execute the script in your terminal.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>infer_bert.py </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">1</span> <span class="p">[</span><span class="s1">'paraphrase'</span><span class="p">]</span> <span class="mi">3</span> <span class="p">[</span><span class="s1">'not paraphrase'</span><span class="p">]</span> <span class="mi">4</span> <span class="p">[</span><span class="s1">'not paraphrase'</span><span class="p">]</span> <span class="mi">0</span> <span class="p">[</span><span class="s1">'paraphrase'</span><span class="p">]</span> <span class="mi">5</span> <span class="p">[</span><span class="s1">'not paraphrase'</span><span class="p">]</span> <span class="mi">2</span> <span class="p">[</span><span class="s1">'paraphrase'</span><span class="p">]</span> </pre></div> </div> <p>We can see that the first three threads (0, 1, 2) all report <code class="docutils literal notranslate"><span class="pre">paraphrase</span></code>, as expected. If we instead modify the script to send an incomplete batch and then wait for the timeout to expire, the excess padding results will be discarded.</p> </div> <div class="section" id="benchmark-torchserve"> <span id="torchserve-benchmark"></span><h2><a class="toc-backref" href="#id10">Benchmark TorchServe</a><a class="headerlink" href="#benchmark-torchserve" title="Permalink to this headline">#</a></h2> <p>We’ve seen how to perform a single batched inference, but how many inferences can we process per second? A separate upcoming tutorial will document performance tuning to maximize throughput. In the meantime, we can still perform a simple naïve stress test. The code below will spawn 64 worker threads, with each thread repeatedly sending a full batch of data to process. A separate thread will periodically print throughput and latency measurements.</p> <div class="literal-block-wrapper docutils container" id="id5"> <div class="code-block-caption"><span class="caption-text"><a class="reference download internal" download="" href="../../../../../_downloads/7b0993cb40a112b1abc9f33f0b6335bb/benchmark_bert.py"><code class="xref download docutils literal notranslate"><span class="pre">benchmark_bert.py</span></code></a></span><a class="headerlink" href="#id5" title="Permalink to this code">#</a></div> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kn">import</span> <span class="nn">os</span> <span class="linenos"> 2</span><span class="kn">import</span> <span class="nn">argparse</span> <span class="linenos"> 3</span><span class="kn">import</span> <span class="nn">time</span> <span class="linenos"> 4</span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> <span class="linenos"> 5</span><span class="kn">import</span> <span class="nn">requests</span> <span class="linenos"> 6</span><span class="kn">import</span> <span class="nn">sys</span> <span class="linenos"> 7</span><span class="kn">from</span> <span class="nn">concurrent</span> <span class="kn">import</span> <span class="n">futures</span> <span class="linenos"> 8</span> <span class="linenos"> 9</span><span class="kn">import</span> <span class="nn">torch</span> <span class="linenos">10</span> <span class="linenos">11</span> <span class="linenos">12</span><span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">()</span> <span class="linenos">13</span><span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--url'</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s1">'Torchserve model URL'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="sa">f</span><span class="s1">'http://127.0.0.1:8080/predictions/bert-max_length128-batch_size6'</span><span class="p">)</span> <span class="linenos">14</span><span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--num_thread'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">64</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s1">'Number of threads invoking the model URL'</span><span class="p">)</span> <span class="linenos">15</span><span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--batch_size'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span> <span class="linenos">16</span><span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--sequence_length'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">128</span><span class="p">)</span> <span class="linenos">17</span><span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--latency_window_size'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">1000</span><span class="p">)</span> <span class="linenos">18</span><span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--throughput_time'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">300</span><span class="p">)</span> <span class="linenos">19</span><span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--throughput_interval'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span> <span class="linenos">20</span><span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span> <span class="linenos">21</span> <span class="linenos">22</span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span> <span class="s1">'seq_0'</span><span class="p">:</span> <span class="s1">'A completely made up sentence.'</span><span class="p">,</span> <span class="linenos">23</span> <span class="s1">'seq_1'</span><span class="p">:</span> <span class="s1">'Well, I suppose they are all made up.'</span> <span class="p">}</span> <span class="linenos">24</span><span class="n">live</span> <span class="o">=</span> <span class="kc">True</span> <span class="linenos">25</span><span class="n">num_infer</span> <span class="o">=</span> <span class="mi">0</span> <span class="linenos">26</span><span class="n">latency_list</span> <span class="o">=</span> <span class="p">[]</span> <span class="linenos">27</span> <span class="linenos">28</span> <span class="linenos">29</span><span class="k">def</span> <span class="nf">one_thread</span><span class="p">(</span><span class="n">pred</span><span class="p">,</span> <span class="n">feed_data</span><span class="p">):</span> <span class="linenos">30</span> <span class="k">global</span> <span class="n">latency_list</span> <span class="linenos">31</span> <span class="k">global</span> <span class="n">num_infer</span> <span class="linenos">32</span> <span class="k">global</span> <span class="n">live</span> <span class="linenos">33</span> <span class="n">session</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">Session</span><span class="p">()</span> <span class="linenos">34</span> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> <span class="linenos">35</span> <span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="linenos">36</span> <span class="n">result</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">pred</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">feed_data</span><span class="p">)</span> <span class="linenos">37</span> <span class="n">latency</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">start</span> <span class="linenos">38</span> <span class="n">latency_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">latency</span><span class="p">)</span> <span class="linenos">39</span> <span class="n">num_infer</span> <span class="o">+=</span> <span class="mi">1</span> <span class="linenos">40</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">live</span><span class="p">:</span> <span class="linenos">41</span> <span class="k">break</span> <span class="linenos">42</span> <span class="linenos">43</span> <span class="linenos">44</span><span class="k">def</span> <span class="nf">current_performance</span><span class="p">():</span> <span class="linenos">45</span> <span class="n">last_num_infer</span> <span class="o">=</span> <span class="n">num_infer</span> <span class="linenos">46</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">throughput_time</span> <span class="o">//</span> <span class="n">args</span><span class="o">.</span><span class="n">throughput_interval</span><span class="p">):</span> <span class="linenos">47</span> <span class="n">current_num_infer</span> <span class="o">=</span> <span class="n">num_infer</span> <span class="linenos">48</span> <span class="n">throughput</span> <span class="o">=</span> <span class="p">(</span><span class="n">current_num_infer</span> <span class="o">-</span> <span class="n">last_num_infer</span><span class="p">)</span> <span class="o">/</span> <span class="n">args</span><span class="o">.</span><span class="n">throughput_interval</span> <span class="linenos">49</span> <span class="n">p50</span> <span class="o">=</span> <span class="mf">0.0</span> <span class="linenos">50</span> <span class="n">p90</span> <span class="o">=</span> <span class="mf">0.0</span> <span class="linenos">51</span> <span class="k">if</span> <span class="n">latency_list</span><span class="p">:</span> <span class="linenos">52</span> <span class="n">p50</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">percentile</span><span class="p">(</span><span class="n">latency_list</span><span class="p">[</span><span class="o">-</span><span class="n">args</span><span class="o">.</span><span class="n">latency_window_size</span><span class="p">:],</span> <span class="mi">50</span><span class="p">)</span> <span class="linenos">53</span> <span class="n">p90</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">percentile</span><span class="p">(</span><span class="n">latency_list</span><span class="p">[</span><span class="o">-</span><span class="n">args</span><span class="o">.</span><span class="n">latency_window_size</span><span class="p">:],</span> <span class="mi">90</span><span class="p">)</span> <span class="linenos">54</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'pid </span><span class="si">{}</span><span class="s1">: current throughput </span><span class="si">{}</span><span class="s1">, latency p50=</span><span class="si">{:.3f}</span><span class="s1"> p90=</span><span class="si">{:.3f}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getpid</span><span class="p">(),</span> <span class="n">throughput</span><span class="p">,</span> <span class="n">p50</span><span class="p">,</span> <span class="n">p90</span><span class="p">))</span> <span class="linenos">55</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span> <span class="linenos">56</span> <span class="n">last_num_infer</span> <span class="o">=</span> <span class="n">current_num_infer</span> <span class="linenos">57</span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">throughput_interval</span><span class="p">)</span> <span class="linenos">58</span> <span class="k">global</span> <span class="n">live</span> <span class="linenos">59</span> <span class="n">live</span> <span class="o">=</span> <span class="kc">False</span> <span class="linenos">60</span> <span class="linenos">61</span> <span class="linenos">62</span><span class="k">with</span> <span class="n">futures</span><span class="o">.</span><span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="n">args</span><span class="o">.</span><span class="n">num_thread</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span> <span class="k">as</span> <span class="n">executor</span><span class="p">:</span> <span class="linenos">63</span> <span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">current_performance</span><span class="p">)</span> <span class="linenos">64</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">num_thread</span><span class="p">):</span> <span class="linenos">65</span> <span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">one_thread</span><span class="p">,</span> <span class="n">args</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span> </pre></div> </div> </div> <p>Run the benchmarking script.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>benchmark_bert.py </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pid</span> <span class="mi">1214554</span><span class="p">:</span> <span class="n">current</span> <span class="n">throughput</span> <span class="mf">0.0</span><span class="p">,</span> <span class="n">latency</span> <span class="n">p50</span><span class="o">=</span><span class="mf">0.000</span> <span class="n">p90</span><span class="o">=</span><span class="mf">0.000</span> <span class="n">pid</span> <span class="mi">1214554</span><span class="p">:</span> <span class="n">current</span> <span class="n">throughput</span> <span class="mf">713.9</span><span class="p">,</span> <span class="n">latency</span> <span class="n">p50</span><span class="o">=</span><span class="mf">0.071</span> <span class="n">p90</span><span class="o">=</span><span class="mf">0.184</span> <span class="n">pid</span> <span class="mi">1214554</span><span class="p">:</span> <span class="n">current</span> <span class="n">throughput</span> <span class="mf">737.9</span><span class="p">,</span> <span class="n">latency</span> <span class="n">p50</span><span class="o">=</span><span class="mf">0.071</span> <span class="n">p90</span><span class="o">=</span><span class="mf">0.184</span> <span class="n">pid</span> <span class="mi">1214554</span><span class="p">:</span> <span class="n">current</span> <span class="n">throughput</span> <span class="mf">731.6</span><span class="p">,</span> <span class="n">latency</span> <span class="n">p50</span><span class="o">=</span><span class="mf">0.068</span> <span class="n">p90</span><span class="o">=</span><span class="mf">0.192</span> <span class="n">pid</span> <span class="mi">1214554</span><span class="p">:</span> <span class="n">current</span> <span class="n">throughput</span> <span class="mf">732.2</span><span class="p">,</span> <span class="n">latency</span> <span class="n">p50</span><span class="o">=</span><span class="mf">0.070</span> <span class="n">p90</span><span class="o">=</span><span class="mf">0.194</span> <span class="n">pid</span> <span class="mi">1214554</span><span class="p">:</span> <span class="n">current</span> <span class="n">throughput</span> <span class="mf">733.9</span><span class="p">,</span> <span class="n">latency</span> <span class="n">p50</span><span class="o">=</span><span class="mf">0.070</span> <span class="n">p90</span><span class="o">=</span><span class="mf">0.187</span> <span class="n">pid</span> <span class="mi">1214554</span><span class="p">:</span> <span class="n">current</span> <span class="n">throughput</span> <span class="mf">739.3</span><span class="p">,</span> <span class="n">latency</span> <span class="n">p50</span><span class="o">=</span><span class="mf">0.071</span> <span class="n">p90</span><span class="o">=</span><span class="mf">0.184</span> <span class="o">...</span> </pre></div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Your throughput numbers may differ from these based on instance type and size.</p> </div> <p><strong>Congratulations!</strong> By now you should have successfully served a batched model over TorchServe.</p> <p>You can now shutdown torchserve.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>torchserve<span class="w"> </span>--stop </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2</p> </div> </a> <a class="right-next" id="next-link" href="../../../torch-neuron/tutorials/tutorial-libtorch.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">LibTorch C++ Tutorial</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:45.958Z
LibTorch C++ Tutorial — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html
# LibTorch C++ Tutorial — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf1` ## LibTorch C++ Tutorial[#](#libtorch-c-tutorial "Permalink to this headline") Table of Contents - [Overview](#overview) - [Notes](#notes) - [Run the tutorial](#run-the-tutorial) - [Benchmark](#benchmark) - [Troubleshooting](#troubleshooting) ## [Overview](#id1)[#](#overview "Permalink to this headline") This tutorial demonstrates the use of [LibTorch](https://pytorch.org/cppdocs/installing.html) with Neuron, the SDK for Amazon Inf1, Inf2 and Trn1 instances. By the end of this tutorial, you will understand how to write a native C++ application that performs inference on EC2 Inf1, Inf2 and Trn1 instances. We will use an inf1.6xlarge and a pretrained BERT-Base model to determine if one sentence is a paraphrase of another. ## [Notes](#id2)[#](#notes "Permalink to this headline") The tutorial has been tested on Inf1, Inf2 and Trn1 instances on ubuntu instances. ## [Run the tutorial](#id3)[#](#run-the-tutorial "Permalink to this headline") This tutorial is self contained. It produces similar output to [\[html\]](../../../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.ipynb). Note: The tutorial will use about 8.5 GB of disk space. Please ensure you have sufficient space before beginning. Right-click and copy [`this link address to the tutorial archive`](../../../../_downloads/172f30d74345f2994f0bb5536f7dc650/libtorch_demo.tar.gz). ``` $ wget <paste archive URL> $ tar xvf libtorch_demo.tar.gz ``` Your directory tree should now look like this: ``` libtorch_demo ├── bert_neuronx │ ├── compile.py │ └── detect_instance.py ├── clean.sh ├── core_count │ ├── build.sh │ └── main.cpp ├── example_app │ ├── build.sh │ ├── core_count.hpp │ ├── example_app.cpp │ ├── README.txt │ ├── utils.cpp │ └── utils.hpp ├── neuron.patch ├── run_tests.sh ├── setup.sh ├── tokenizer.json └── tokenizers_binding ├── build_python.sh ├── build.sh ├── remote_rust_tokenizer.h ├── run_python.sh ├── run.sh ├── tokenizer.json ├── tokenizer_test ├── tokenizer_test.cpp └── tokenizer_test.py ``` This tutorial uses the [HuggingFace Tokenizers](https://github.com/huggingface/tokenizers) library implemented in Rust. Install Cargo, the package manager for the Rust programming language. > <table class="table"><colgroup><col> <col> </colgroup><tbody><tr class="row-odd"><td><p>Ubuntu</p></td><td><p>AL2</p></td></tr><tr class="row-even"><td><div class="highlight-bash notranslate"><pre><span></span>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>cargo > </pre></div></td><td><div class="highlight-bash notranslate"><pre><span></span>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>cargo > </pre></div></td></tr></tbody></table> Run the setup script to download additional depdendencies and build the app. (This may take a few minutes to complete.) ``` $ cd libtorch_demo $ chmod +x setup.sh && ./setup.sh ``` ``` ... + g++ utils.cpp example_app.cpp -o ../example-app -O2 -D_GLIBCXX_USE_CXX11_ABI=0 -I../libtorch/include -L../tokenizers_binding/lib -L/opt/aws/neuron/lib/ -L../libtorch/lib -Wl,-rpath,libtorch/lib -Wl,-rpath,tokenizers_binding/lib -Wl,-rpath,/opt/aws/neuron/lib/ -ltokenizers -ltorchneuron -ltorch_cpu -lc10 -lpthread -lnrt ~/libtorch_demo Successfully completed setup ``` ## [Benchmark](#id4)[#](#benchmark "Permalink to this headline") The setup script should have compiled and saved a PyTorch model compiled for neuron (bert\_neuron\_b6.pt). Run the provided sanity tests to ensure everything is working properly. ``` $ ./run_tests.sh bert_neuron_b6.pt ``` ``` Running tokenization sanity checks. None of PyTorch, TensorFlow >= 2.0, or Flax have been found. Models won't be available and only tokenizers, configuration and file/data utilities can be used. Tokenizing: 100%|██████████████████████████████████████████████████████████████████████████████████| 10000/10000 [00:00<00:00, 15021.69it/s] Python took 0.67 seconds. Sanity check passed. Begin 10000 timed tests. .......... End timed tests. C++ took 0.226 seconds. Tokenization sanity checks passed. Running end-to-end sanity check. The company HuggingFace is based in New York City HuggingFace's headquarters are situated in Manhattan not paraphrase: 10% paraphrase: 90% The company HuggingFace is based in New York City Apples are especially bad for your health not paraphrase: 94% paraphrase: 6% Sanity check passed. ``` Finally, run the example app directly to benchmark the BERT model. Note You can safely ignore the warning about `None of PyTorch, Tensorflow >= 2.0, ...`. This occurs because the test runs in a small virtual environment that doesn’t require the full frameworks. ``` $ ./example-app bert_neuron_b6.pt ``` ``` Getting ready................ Benchmarking................ Completed 32000 operations in 43 seconds => 4465.12 pairs / second ==================== Summary information: ==================== Batch size = 6 Num neuron cores = 16 Num runs per neuron core = 2000 ``` **Congratulations!** By now you should have successfully built and used a native C++ application with LibTorch. ## [Troubleshooting](#id5)[#](#troubleshooting "Permalink to this headline") - In the event of SIGBUS errors you may have insufficient disk space for the creation of temporary model files at runtime. Consider clearing space or mounting additional disk storage. - In the event of a neuron runtime failure, confirm that the Neuron kernel module is loaded using `sudo modprobe neuron`. _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>LibTorch C++ Tutorial — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Compiling and Deploying ResNet50 on Trn1 or Inf2" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> <link rel="prev" title="BERT TorchServe Tutorial" href="../../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/tutorials/tutorial-libtorch", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/tutorials/tutorial-libtorch.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#overview"> Overview </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#notes"> Notes </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#run-the-tutorial"> Run the tutorial </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#benchmark"> Benchmark </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#troubleshooting"> Troubleshooting </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>LibTorch C++ Tutorial</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#overview"> Overview </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#notes"> Notes </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#run-the-tutorial"> Run the tutorial </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#benchmark"> Benchmark </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#troubleshooting"> Troubleshooting </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="libtorch-c-tutorial"> <span id="pytorch-tutorials-libtorch"></span><h1>LibTorch C++ Tutorial<a class="headerlink" href="#libtorch-c-tutorial" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#overview" id="id1">Overview</a></p></li> <li><p><a class="reference internal" href="#notes" id="id2">Notes</a></p></li> <li><p><a class="reference internal" href="#run-the-tutorial" id="id3">Run the tutorial</a></p></li> <li><p><a class="reference internal" href="#benchmark" id="id4">Benchmark</a></p></li> <li><p><a class="reference internal" href="#troubleshooting" id="id5">Troubleshooting</a></p></li> </ul> </div> <div class="section" id="overview"> <h2><a class="toc-backref" href="#id1">Overview</a><a class="headerlink" href="#overview" title="Permalink to this headline">#</a></h2> <p>This tutorial demonstrates the use of <a class="reference external" href="https://pytorch.org/cppdocs/installing.html">LibTorch</a> with Neuron, the SDK for Amazon Inf1, Inf2 and Trn1 instances. By the end of this tutorial, you will understand how to write a native C++ application that performs inference on EC2 Inf1, Inf2 and Trn1 instances. We will use an inf1.6xlarge and a pretrained BERT-Base model to determine if one sentence is a paraphrase of another.</p> </div> <div class="section" id="notes"> <h2><a class="toc-backref" href="#id2">Notes</a><a class="headerlink" href="#notes" title="Permalink to this headline">#</a></h2> <p>The tutorial has been tested on Inf1, Inf2 and Trn1 instances on ubuntu instances.</p> </div> <div class="section" id="run-the-tutorial"> <h2><a class="toc-backref" href="#id3">Run the tutorial</a><a class="headerlink" href="#run-the-tutorial" title="Permalink to this headline">#</a></h2> <p>This tutorial is self contained. It produces similar output to <a class="reference internal" href="../../../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.ipynb">[notebook]</a>.</p> <p>Note: The tutorial will use about 8.5 GB of disk space. Please ensure you have sufficient space before beginning.</p> <p>Right-click and copy <a class="reference download internal" download="" href="../../../../_downloads/172f30d74345f2994f0bb5536f7dc650/libtorch_demo.tar.gz"><code class="xref download docutils literal notranslate"><span class="pre">this</span> <span class="pre">link</span> <span class="pre">address</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">tutorial</span> <span class="pre">archive</span></code></a>.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>wget<span class="w"> </span>&lt;paste<span class="w"> </span>archive<span class="w"> </span>URL&gt; $<span class="w"> </span>tar<span class="w"> </span>xvf<span class="w"> </span>libtorch_demo.tar.gz </pre></div> </div> <p>Your directory tree should now look like this:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>libtorch_demo ├── bert_neuronx │ ├── compile.py │ └── detect_instance.py ├── clean.sh ├── core_count │ ├── build.sh │ └── main.cpp ├── example_app │ ├── build.sh │ ├── core_count.hpp │ ├── example_app.cpp │ ├── README.txt │ ├── utils.cpp │ └── utils.hpp ├── neuron.patch ├── run_tests.sh ├── setup.sh ├── tokenizer.json └── tokenizers_binding ├── build_python.sh ├── build.sh ├── remote_rust_tokenizer.h ├── run_python.sh ├── run.sh ├── tokenizer.json ├── tokenizer_test ├── tokenizer_test.cpp └── tokenizer_test.py </pre></div> </div> <p>This tutorial uses the <a class="reference external" href="https://github.com/huggingface/tokenizers">HuggingFace Tokenizers</a> library implemented in Rust. Install Cargo, the package manager for the Rust programming language.</p> <blockquote> <div><table class="table"> <colgroup> <col style="width: 50%"> <col style="width: 50%"> </colgroup> <tbody> <tr class="row-odd"><td><p>Ubuntu</p></td> <td><p>AL2</p></td> </tr> <tr class="row-even"><td><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>cargo </pre></div> </div> </td> <td><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>cargo </pre></div> </div> </td> </tr> </tbody> </table> </div></blockquote> <p>Run the setup script to download additional depdendencies and build the app. (This may take a few minutes to complete.)</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>libtorch_demo $<span class="w"> </span>chmod<span class="w"> </span>+x<span class="w"> </span>setup.sh<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>./setup.sh </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="o">+</span> <span class="n">g</span><span class="o">++</span> <span class="n">utils</span><span class="o">.</span><span class="n">cpp</span> <span class="n">example_app</span><span class="o">.</span><span class="n">cpp</span> <span class="o">-</span><span class="n">o</span> <span class="o">../</span><span class="n">example</span><span class="o">-</span><span class="n">app</span> <span class="o">-</span><span class="n">O2</span> <span class="o">-</span><span class="n">D_GLIBCXX_USE_CXX11_ABI</span><span class="o">=</span><span class="mi">0</span> <span class="o">-</span><span class="n">I</span><span class="o">../</span><span class="n">libtorch</span><span class="o">/</span><span class="n">include</span> <span class="o">-</span><span class="n">L</span><span class="o">../</span><span class="n">tokenizers_binding</span><span class="o">/</span><span class="n">lib</span> <span class="o">-</span><span class="n">L</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">aws</span><span class="o">/</span><span class="n">neuron</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span> <span class="o">-</span><span class="n">L</span><span class="o">../</span><span class="n">libtorch</span><span class="o">/</span><span class="n">lib</span> <span class="o">-</span><span class="n">Wl</span><span class="p">,</span><span class="o">-</span><span class="n">rpath</span><span class="p">,</span><span class="n">libtorch</span><span class="o">/</span><span class="n">lib</span> <span class="o">-</span><span class="n">Wl</span><span class="p">,</span><span class="o">-</span><span class="n">rpath</span><span class="p">,</span><span class="n">tokenizers_binding</span><span class="o">/</span><span class="n">lib</span> <span class="o">-</span><span class="n">Wl</span><span class="p">,</span><span class="o">-</span><span class="n">rpath</span><span class="p">,</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">aws</span><span class="o">/</span><span class="n">neuron</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span> <span class="o">-</span><span class="n">ltokenizers</span> <span class="o">-</span><span class="n">ltorchneuron</span> <span class="o">-</span><span class="n">ltorch_cpu</span> <span class="o">-</span><span class="n">lc10</span> <span class="o">-</span><span class="n">lpthread</span> <span class="o">-</span><span class="n">lnrt</span> <span class="o">~/</span><span class="n">libtorch_demo</span> <span class="n">Successfully</span> <span class="n">completed</span> <span class="n">setup</span> </pre></div> </div> </div> <div class="section" id="benchmark"> <span id="libtorch-benchmark"></span><h2><a class="toc-backref" href="#id4">Benchmark</a><a class="headerlink" href="#benchmark" title="Permalink to this headline">#</a></h2> <p>The setup script should have compiled and saved a PyTorch model compiled for neuron (bert_neuron_b6.pt). Run the provided sanity tests to ensure everything is working properly.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>./run_tests.sh<span class="w"> </span>bert_neuron_b6.pt </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>Running tokenization sanity checks. None of PyTorch, TensorFlow &gt;= 2.0, or Flax have been found. Models won't be available and only tokenizers, configuration and file/data utilities can be used. Tokenizing: 100%|██████████████████████████████████████████████████████████████████████████████████| 10000/10000 [00:00&lt;00:00, 15021.69it/s] Python took 0.67 seconds. Sanity check passed. Begin 10000 timed tests. .......... End timed tests. C++ took 0.226 seconds. Tokenization sanity checks passed. Running end-to-end sanity check. The company HuggingFace is based in New York City HuggingFace's headquarters are situated in Manhattan not paraphrase: 10% paraphrase: 90% The company HuggingFace is based in New York City Apples are especially bad for your health not paraphrase: 94% paraphrase: 6% Sanity check passed. </pre></div> </div> <p>Finally, run the example app directly to benchmark the BERT model.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>You can safely ignore the warning about <code class="docutils literal notranslate"><span class="pre">None</span> <span class="pre">of</span> <span class="pre">PyTorch,</span> <span class="pre">Tensorflow</span> <span class="pre">&gt;=</span> <span class="pre">2.0,</span> <span class="pre">...</span></code>. This occurs because the test runs in a small virtual environment that doesn’t require the full frameworks.</p> </div> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>./example-app<span class="w"> </span>bert_neuron_b6.pt </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Getting</span> <span class="n">ready</span><span class="o">................</span> <span class="n">Benchmarking</span><span class="o">................</span> <span class="n">Completed</span> <span class="mi">32000</span> <span class="n">operations</span> <span class="ow">in</span> <span class="mi">43</span> <span class="n">seconds</span> <span class="o">=&gt;</span> <span class="mf">4465.12</span> <span class="n">pairs</span> <span class="o">/</span> <span class="n">second</span> <span class="o">====================</span> <span class="n">Summary</span> <span class="n">information</span><span class="p">:</span> <span class="o">====================</span> <span class="n">Batch</span> <span class="n">size</span> <span class="o">=</span> <span class="mi">6</span> <span class="n">Num</span> <span class="n">neuron</span> <span class="n">cores</span> <span class="o">=</span> <span class="mi">16</span> <span class="n">Num</span> <span class="n">runs</span> <span class="n">per</span> <span class="n">neuron</span> <span class="n">core</span> <span class="o">=</span> <span class="mi">2000</span> </pre></div> </div> <p><strong>Congratulations!</strong> By now you should have successfully built and used a native C++ application with LibTorch.</p> </div> <div class="section" id="troubleshooting"> <h2><a class="toc-backref" href="#id5">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p>In the event of SIGBUS errors you may have insufficient disk space for the creation of temporary model files at runtime. Consider clearing space or mounting additional disk storage.</p></li> <li><p>In the event of a neuron runtime failure, confirm that the Neuron kernel module is loaded using <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">modprobe</span> <span class="pre">neuron</span></code>.</p></li> </ul> <p id="libtorch-cleanup"><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">BERT TorchServe Tutorial</p> </div> </a> <a class="right-next" id="next-link" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Compiling and Deploying ResNet50 on Trn1 or Inf2</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:46.309Z
Compiling and Deploying ResNet50 on Trn1 or Inf2 — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html
# Compiling and Deploying ResNet50 on Trn1 or Inf2 — AWS Neuron Documentation ## Compiling and Deploying ResNet50 on Trn1 or Inf2[#](#Compiling-and-Deploying-ResNet50-on-Trn1-or-Inf2 "Permalink to this headline") ## Introduction[#](#Introduction "Permalink to this headline") In this tutorial we will compile and deploy a TorchVision ResNet50 model for accelerated inference on Neuron. To get started with Jupyter Notebook on Neuron Instance you launched, please use this [guide](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html). This tutorial will use the [resnet50](https://pytorch.org/vision/main/models/generated/torchvision.models.resnet50.html) model, which is primarily used for arbitrary image classification tasks. This tutorial has the following main sections: 1. Install dependencies 2. Compile the ResNet model 3. Run inference on Neuron and compare results to CPU 4. Benchmark the model using multicore inference 5. Finding the optimal batch size This Jupyter notebook should be run on a Trn1 instance (`trn1.2xlarge` or larger.) or Inf2 instance (`inf2.xlarge` or larger.) ## Install Dependencies[#](#Install-Dependencies "Permalink to this headline") The code in this tutorial is written for Jupyter Notebooks. To use Jupyter Notebook on the Neuron instance, you can use this [guide](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html). This tutorial requires the following pip packages: - `torch-neuronx` - `neuronx-cc` - `torchvision` - `Pillow` Most of these packages will be installed when configuring your environment using the Trn1 setup guide. The additional dependencies must be installed here: ## Compile the model into an AWS Neuron optimized TorchScript[#](#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript "Permalink to this headline") In the following section, we load the model, get a sample input, run inference on CPU, compile the model for Neuron using `torch_neuronx.trace()`, and save the optimized model as `TorchScript`. `torch_neuronx.trace()` expects a tensor or tuple of tensor inputs to use for tracing, so we convert the input image into a tensor using the `get_image` function. The result of the trace stage will be a static executable where the operations to be run upon inference are determined during compilation. This means that when inferring, the resulting Neuron model must be executed with tensors that are the exact same shape as those provided at compilation time. If a model is given a tensor at inference time whose shape does not match the tensor given at compilation time, an error will occur. In the following section, we assume that we will receive an image shape of `[1, 3, 224, 224]` at inference time. ``` import os import urllib from PIL import Image import torch import torch_neuronx from torchvision import models from torchvision.transforms import functional def get_image(batch_size=1, image_shape=(224, 224)): # Get an example input filename = "000000039769.jpg" if not os.path.exists(filename): url = "http://images.cocodataset.org/val2017/000000039769.jpg" urllib.request.urlretrieve(url, filename) image = Image.open(filename).convert('RGB') image = functional.resize(image, (image_shape)) image = functional.to_tensor(image) image = torch.unsqueeze(image, 0) image = torch.repeat_interleave(image, batch_size, 0) return (image, ) # Create the model model = models.resnet50(pretrained=True) model.eval() # Get an example input image = get_image() # Run inference on CPU output_cpu = model(*image) # Compile the model model_neuron = torch_neuronx.trace(model, image) # Save the TorchScript for inference deployment filename = 'model.pt' torch.jit.save(model_neuron, filename) ``` ## Run inference and compare results[#](#Run-inference-and-compare-results "Permalink to this headline") In this section we load the compiled model, run inference on Neuron, and compare the CPU and Neuron outputs using the ImageNet classes. ``` import json # Load the TorchScript compiled model model_neuron = torch.jit.load(filename) # Run inference using the Neuron model output_neuron = model_neuron(*image) # Compare the results print(f"CPU tensor: {output_cpu[0][0:10]}") print(f"Neuron tensor: {output_neuron[0][0:10]}") # Download and read the ImageNet classes urllib.request.urlretrieve("https://s3.amazonaws.com/deep-learning-models/image-models/imagenet_class_index.json","imagenet_class_index.json") with open("imagenet_class_index.json", "r") as file: class_id = json.load(file) id2label = [class_id[str(i)][1] for i in range(len(class_id))] # Lookup and print the top-5 labels top5_cpu = output_cpu[0].sort()[1][-5:] top5_neuron = output_neuron[0].sort()[1][-5:] top5_labels_cpu = [id2label[idx] for idx in top5_cpu] top5_labels_neuron = [id2label[idx] for idx in top5_neuron] print(f"CPU top-5 labels: {top5_labels_cpu}") print(f"Neuron top-5 labels: {top5_labels_neuron}") ``` ## Benchmarking[#](#Benchmarking "Permalink to this headline") In this section we benchmark the performance of the ResNet model on Neuron. By default, models compiled with `torch_neuronx` will always execute on a _single_ NeuronCore. When loading _multiple_ models, the default behavior of the Neuron runtime is to evenly distribute models across all available NeuronCores. The runtime places models on the NeuronCore that has the fewest models loaded to it first. In the following section, we will `torch.jit.load` multiple instances of the model which should each be loaded onto their own NeuronCore. It is not useful to load more copies of a model than the number of NeuronCores on the instance since an individual NeuronCore can only execute one model at a time. To ensure that we are maximizing hardware utilization, we must run inferences using multiple threads in parallel. It is nearly always recommended to use some form of threading/multiprocessing and some form of model replication since even the smallest Neuron EC2 instance has 2 NeuronCores available. Applications with no form of threading are only capable of `1 / num_neuron_cores` hardware utilization which becomes especially problematic on large instances. One way to view the hardware utilization is by executing the `neuron-top` application in the terminal while the benchmark is executing. If the monitor shows >90% utilization on all NeuronCores, this is a good indication that the hardware is being utilized effectively. In this example we load two models, which utilizes all NeuronCores (2) on a `trn1.2xlarge` or `inf2.xlarge` instance. Additional models can be loaded and run in parallel on larger Trn1 or Inf2 instance sizes to increase throughput. We define a benchmarking function that loads two optimized ResNet models onto two separate NeuronCores, runs multithreaded inference, and calculates the corresponding latency and throughput. ``` import time import concurrent.futures import numpy as np def benchmark(filename, example, n_models=2, n_threads=2, batches_per_thread=1000): """ Record performance statistics for a serialized model and its input example. Arguments: filename: The serialized torchscript model to load for benchmarking. example: An example model input. n_models: The number of models to load. n_threads: The number of simultaneous threads to execute inferences on. batches_per_thread: The number of example batches to run per thread. Returns: A dictionary of performance statistics. """ # Load models models = [torch.jit.load(filename) for _ in range(n_models)] # Warmup for _ in range(8): for model in models: model(*example) latencies = [] # Thread task def task(model): for _ in range(batches_per_thread): start = time.time() model(*example) finish = time.time() latencies.append((finish - start) * 1000) # Submit tasks begin = time.time() with concurrent.futures.ThreadPoolExecutor(max_workers=n_threads) as pool: for i in range(n_threads): pool.submit(task, models[i % len(models)]) end = time.time() # Compute metrics boundaries = [50, 95, 99] percentiles = {} for boundary in boundaries: name = f'latency_p{boundary}' percentiles[name] = np.percentile(latencies, boundary) duration = end - begin batch_size = 0 for tensor in example: if batch_size == 0: batch_size = tensor.shape[0] inferences = len(latencies) * batch_size throughput = inferences / duration # Metrics metrics = { 'filename': str(filename), 'batch_size': batch_size, 'batches': len(latencies), 'inferences': inferences, 'threads': n_threads, 'models': n_models, 'duration': duration, 'throughput': throughput, **percentiles, } display(metrics) def display(metrics): """ Display the metrics produced by `benchmark` function. Args: metrics: A dictionary of performance statistics. """ pad = max(map(len, metrics)) + 1 for key, value in metrics.items(): parts = key.split('_') parts = list(map(str.title, parts)) title = ' '.join(parts) + ":" if isinstance(value, float): value = f'{value:0.3f}' print(f'{title :<{pad}} {value}') # Benchmark ResNet on Neuron benchmark(filename, image) ``` ## Finding the optimal batch size[#](#Finding-the-optimal-batch-size "Permalink to this headline") Batch size has a direct impact on model performance. The NeuronCore architecture is optimized to maximize throughput with relatively small batch sizes. This means that a Neuron compiled model can outperform a GPU model, even if running single digit batch sizes. As a general best practice, we recommend optimizing your model’s throughput by compiling the model with a small batch size and gradually increasing it to find the peak throughput on Neuron. To minimize latency, using `batch size = 1` will nearly always be optimal. This batch size configuration is typically used for on-demand inference applications. To maximize throughput, _usually_ `1 < batch_size < 10` is optimal. A configuration which uses a larger batch size is generally ideal for batched on-demand inference or offline batch processing. In the following section, we compile ResNet for multiple batch size inputs. We then run inference on each batch size and benchmark the performance. Notice that latency increases consistently as the batch size increases. Throughput increases as well, up until a certain point where the input size becomes too large to be efficient. ``` # Compile ResNet for different batch sizes for batch_size in [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]: model = models.resnet50(pretrained=True) model.eval() example = get_image(batch_size=batch_size) model_neuron = torch_neuronx.trace(model, example) filename = f'model_batch_size_{batch_size}.pt' torch.jit.save(model_neuron, filename) ``` ``` # Benchmark ResNet for different batch sizes for batch_size in [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]: print('-'*50) example = get_image(batch_size=batch_size) filename = f'model_batch_size_{batch_size}.pt' benchmark(filename, example) print() ```
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Compiling and Deploying ResNet50 on Trn1 or Inf2 — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script>window.MathJax = {"tex": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true}, "options": {"ignoreHtmlClass": "tex2jax_ignore|mathjax_ignore|document", "processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script> <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="T5 model inference on Trn1 or Inf2" href="t5-inference-tutorial.html"> <link rel="prev" title="LibTorch C++ Tutorial" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".ipynb", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <style type="text/css">.CtxtMenu_InfoClose { top:.2em; right:.2em;} .CtxtMenu_InfoContent { overflow:auto; text-align:left; font-size:80%; padding:.4em .6em; border:1px inset; margin:1em 0px; max-height:20em; max-width:30em; background-color:#EEEEEE; white-space:normal;} .CtxtMenu_Info.CtxtMenu_MousePost {outline:none;} .CtxtMenu_Info { position:fixed; left:50%; width:auto; text-align:center; border:3px outset; padding:1em 2em; background-color:#DDDDDD; color:black; cursor:default; font-family:message-box; font-size:120%; font-style:normal; text-indent:0; text-transform:none; line-height:normal; letter-spacing:normal; word-spacing:normal; word-wrap:normal; white-space:nowrap; float:none; z-index:201; border-radius: 15px; /* Opera 10.5 and IE9 */ -webkit-border-radius:15px; /* Safari and Chrome */ -moz-border-radius:15px; /* Firefox */ -khtml-border-radius:15px; /* Konqueror */ box-shadow:0px 10px 20px #808080; /* Opera 10.5 and IE9 */ -webkit-box-shadow:0px 10px 20px #808080; /* Safari 3 & Chrome */ -moz-box-shadow:0px 10px 20px #808080; /* Forefox 3.5 */ -khtml-box-shadow:0px 10px 20px #808080; /* Konqueror */ filter:progid:DXImageTransform.Microsoft.dropshadow(OffX=2, OffY=2, Color="gray", Positive="true"); /* IE */} </style><style type="text/css">.CtxtMenu_MenuClose { position:absolute; cursor:pointer; display:inline-block; border:2px solid #AAA; border-radius:18px; -webkit-border-radius: 18px; /* Safari and Chrome */ -moz-border-radius: 18px; /* Firefox */ -khtml-border-radius: 18px; /* Konqueror */ font-family: "Courier New", Courier; font-size:24px; color:#F0F0F0} .CtxtMenu_MenuClose span { display:block; background-color:#AAA; border:1.5px solid; border-radius:18px; -webkit-border-radius: 18px; /* Safari and Chrome */ -moz-border-radius: 18px; /* Firefox */ -khtml-border-radius: 18px; /* Konqueror */ line-height:0; padding:8px 0 6px /* may need to be browser-specific */} .CtxtMenu_MenuClose:hover { color:white!important; border:2px solid #CCC!important} .CtxtMenu_MenuClose:hover span { background-color:#CCC!important} .CtxtMenu_MenuClose:hover:focus { outline:none} </style><style type="text/css">.CtxtMenu_Menu { position:absolute; background-color:white; color:black; width:auto; padding:5px 0px; border:1px solid #CCCCCC; margin:0; cursor:default; font: menu; text-align:left; text-indent:0; text-transform:none; line-height:normal; letter-spacing:normal; word-spacing:normal; word-wrap:normal; white-space:nowrap; float:none; z-index:201; border-radius: 5px; /* Opera 10.5 and IE9 */ -webkit-border-radius: 5px; /* Safari and Chrome */ -moz-border-radius: 5px; /* Firefox */ -khtml-border-radius: 5px; /* Konqueror */ box-shadow:0px 10px 20px #808080; /* Opera 10.5 and IE9 */ -webkit-box-shadow:0px 10px 20px #808080; /* Safari 3 & Chrome */ -moz-box-shadow:0px 10px 20px #808080; /* Forefox 3.5 */ -khtml-box-shadow:0px 10px 20px #808080; /* Konqueror */} .CtxtMenu_MenuItem { padding: 1px 2em; background:transparent;} .CtxtMenu_MenuArrow { position:absolute; right:.5em; padding-top:.25em; color:#666666; font-family: null; font-size: .75em} .CtxtMenu_MenuActive .CtxtMenu_MenuArrow {color:white} .CtxtMenu_MenuArrow.CtxtMenu_RTL {left:.5em; right:auto} .CtxtMenu_MenuCheck { position:absolute; left:.7em; font-family: null} .CtxtMenu_MenuCheck.CtxtMenu_RTL { right:.7em; left:auto } .CtxtMenu_MenuRadioCheck { position:absolute; left: .7em;} .CtxtMenu_MenuRadioCheck.CtxtMenu_RTL { right: .7em; left:auto} .CtxtMenu_MenuInputBox { padding-left: 1em; right:.5em; color:#666666; font-family: null;} .CtxtMenu_MenuInputBox.CtxtMenu_RTL { left: .1em;} .CtxtMenu_MenuComboBox { left:.1em; padding-bottom:.5em;} .CtxtMenu_MenuSlider { left: .1em;} .CtxtMenu_SliderValue { position:absolute; right:.1em; padding-top:.25em; color:#333333; font-size: .75em} .CtxtMenu_SliderBar { outline: none; background: #d3d3d3} .CtxtMenu_MenuLabel { padding: 1px 2em 3px 1.33em; font-style:italic} .CtxtMenu_MenuRule { border-top: 1px solid #DDDDDD; margin: 4px 3px;} .CtxtMenu_MenuDisabled { color:GrayText} .CtxtMenu_MenuActive { background-color: #606872; color: white;} .CtxtMenu_MenuDisabled:focus { background-color: #E8E8E8} .CtxtMenu_MenuLabel:focus { background-color: #E8E8E8} .CtxtMenu_ContextMenu:focus { outline:none} .CtxtMenu_ContextMenu .CtxtMenu_MenuItem:focus { outline:none} .CtxtMenu_SelectionMenu { position:relative; float:left; border-bottom: none; -webkit-box-shadow:none; -webkit-border-radius:0px; } .CtxtMenu_SelectionItem { padding-right: 1em;} .CtxtMenu_Selection { right: 40%; width:50%; } .CtxtMenu_SelectionBox { padding: 0em; max-height:20em; max-width: none; background-color:#FFFFFF;} .CtxtMenu_SelectionDivider { clear: both; border-top: 2px solid #000000;} .CtxtMenu_Menu .CtxtMenu_MenuClose { top:-10px; left:-10px} </style><style id="MJX-CHTML-styles"> mjx-container[jax="CHTML"] { line-height: 0; } mjx-container [space="1"] { margin-left: .111em; } mjx-container [space="2"] { margin-left: .167em; } mjx-container [space="3"] { margin-left: .222em; } mjx-container [space="4"] { margin-left: .278em; } mjx-container [space="5"] { margin-left: .333em; } mjx-container [rspace="1"] { margin-right: .111em; } mjx-container [rspace="2"] { margin-right: .167em; } mjx-container [rspace="3"] { margin-right: .222em; } mjx-container [rspace="4"] { margin-right: .278em; } mjx-container [rspace="5"] { margin-right: .333em; } mjx-container [size="s"] { font-size: 70.7%; } mjx-container [size="ss"] { font-size: 50%; } mjx-container [size="Tn"] { font-size: 60%; } mjx-container [size="sm"] { font-size: 85%; } mjx-container [size="lg"] { font-size: 120%; } mjx-container [size="Lg"] { font-size: 144%; } mjx-container [size="LG"] { font-size: 173%; } mjx-container [size="hg"] { font-size: 207%; } mjx-container [size="HG"] { font-size: 249%; } mjx-container [width="full"] { width: 100%; } mjx-box { display: inline-block; } mjx-block { display: block; } mjx-itable { display: inline-table; } mjx-row { display: table-row; } mjx-row > * { display: table-cell; } mjx-mtext { display: inline-block; } mjx-mstyle { display: inline-block; } mjx-merror { display: inline-block; color: red; background-color: yellow; } mjx-mphantom { visibility: hidden; } _::-webkit-full-page-media, _:future, :root mjx-container { will-change: opacity; } mjx-assistive-mml { position: absolute !important; top: 0px; left: 0px; clip: rect(1px, 1px, 1px, 1px); padding: 1px 0px 0px 0px !important; border: 0px !important; display: block !important; width: auto !important; overflow: hidden !important; -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } mjx-assistive-mml[display="block"] { width: 100% !important; } mjx-c::before { display: block; width: 0; } .MJX-TEX { font-family: MJXZERO, MJXTEX; } .TEX-B { font-family: MJXZERO, MJXTEX-B; } .TEX-I { font-family: MJXZERO, MJXTEX-I; } .TEX-MI { font-family: MJXZERO, MJXTEX-MI; } .TEX-BI { font-family: MJXZERO, MJXTEX-BI; } .TEX-S1 { font-family: MJXZERO, MJXTEX-S1; } .TEX-S2 { font-family: MJXZERO, MJXTEX-S2; } .TEX-S3 { font-family: MJXZERO, MJXTEX-S3; } .TEX-S4 { font-family: MJXZERO, MJXTEX-S4; } .TEX-A { font-family: MJXZERO, MJXTEX-A; } .TEX-C { font-family: MJXZERO, MJXTEX-C; } .TEX-CB { font-family: MJXZERO, MJXTEX-CB; } .TEX-FR { font-family: MJXZERO, MJXTEX-FR; } .TEX-FRB { font-family: MJXZERO, MJXTEX-FRB; } .TEX-SS { font-family: MJXZERO, MJXTEX-SS; } .TEX-SSB { font-family: MJXZERO, MJXTEX-SSB; } .TEX-SSI { font-family: MJXZERO, MJXTEX-SSI; } .TEX-SC { font-family: MJXZERO, MJXTEX-SC; } .TEX-T { font-family: MJXZERO, MJXTEX-T; } .TEX-V { font-family: MJXZERO, MJXTEX-V; } .TEX-VB { font-family: MJXZERO, MJXTEX-VB; } mjx-stretchy-v mjx-c, mjx-stretchy-h mjx-c { font-family: MJXZERO, MJXTEX-S1, MJXTEX-S4, MJXTEX, MJXTEX-A ! important; } @font-face /* 0 */ { font-family: MJXZERO; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Zero.woff") format("woff"); } @font-face /* 1 */ { font-family: MJXTEX; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Regular.woff") format("woff"); } @font-face /* 2 */ { font-family: MJXTEX-B; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Bold.woff") format("woff"); } @font-face /* 3 */ { font-family: MJXTEX-I; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Math-Italic.woff") format("woff"); } @font-face /* 4 */ { font-family: MJXTEX-MI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Italic.woff") format("woff"); } @font-face /* 5 */ { font-family: MJXTEX-BI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Math-BoldItalic.woff") format("woff"); } @font-face /* 6 */ { font-family: MJXTEX-S1; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size1-Regular.woff") format("woff"); } @font-face /* 7 */ { font-family: MJXTEX-S2; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size2-Regular.woff") format("woff"); } @font-face /* 8 */ { font-family: MJXTEX-S3; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size3-Regular.woff") format("woff"); } @font-face /* 9 */ { font-family: MJXTEX-S4; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size4-Regular.woff") format("woff"); } @font-face /* 10 */ { font-family: MJXTEX-A; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_AMS-Regular.woff") format("woff"); } @font-face /* 11 */ { font-family: MJXTEX-C; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Regular.woff") format("woff"); } @font-face /* 12 */ { font-family: MJXTEX-CB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Bold.woff") format("woff"); } @font-face /* 13 */ { font-family: MJXTEX-FR; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Regular.woff") format("woff"); } @font-face /* 14 */ { font-family: MJXTEX-FRB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Bold.woff") format("woff"); } @font-face /* 15 */ { font-family: MJXTEX-SS; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Regular.woff") format("woff"); } @font-face /* 16 */ { font-family: MJXTEX-SSB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Bold.woff") format("woff"); } @font-face /* 17 */ { font-family: MJXTEX-SSI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Italic.woff") format("woff"); } @font-face /* 18 */ { font-family: MJXTEX-SC; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Script-Regular.woff") format("woff"); } @font-face /* 19 */ { font-family: MJXTEX-T; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Typewriter-Regular.woff") format("woff"); } @font-face /* 20 */ { font-family: MJXTEX-V; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Regular.woff") format("woff"); } @font-face /* 21 */ { font-family: MJXTEX-VB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Bold.woff") format("woff"); } </style><script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fsrc/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.ipynb" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.ipynb.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.ipynb</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Install-Dependencies"> Install Dependencies </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript"> Compile the model into an AWS Neuron optimized TorchScript </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-inference-and-compare-results"> Run inference and compare results </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Benchmarking"> Benchmarking </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Finding-the-optimal-batch-size"> Finding the optimal batch size </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Compiling and Deploying ResNet50 on Trn1 or Inf2</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Install-Dependencies"> Install Dependencies </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript"> Compile the model into an AWS Neuron optimized TorchScript </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-inference-and-compare-results"> Run inference and compare results </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Benchmarking"> Benchmarking </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Finding-the-optimal-batch-size"> Finding the optimal batch size </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <style> /* CSS for nbsphinx extension */ /* remove conflicting styling from Sphinx themes */ div.nbinput.container div.prompt *, div.nboutput.container div.prompt *, div.nbinput.container div.input_area pre, div.nboutput.container div.output_area pre, div.nbinput.container div.input_area .highlight, div.nboutput.container div.output_area .highlight { border: none; padding: 0; margin: 0; box-shadow: none; } div.nbinput.container > div[class*=highlight], div.nboutput.container > div[class*=highlight] { margin: 0; } div.nbinput.container div.prompt *, div.nboutput.container div.prompt * { background: none; } div.nboutput.container div.output_area .highlight, div.nboutput.container div.output_area pre { background: unset; } div.nboutput.container div.output_area div.highlight { color: unset; /* override Pygments text color */ } /* avoid gaps between output lines */ div.nboutput.container div[class*=highlight] pre { line-height: normal; } /* input/output containers */ div.nbinput.container, div.nboutput.container { display: -webkit-flex; display: flex; align-items: flex-start; margin: 0; width: 100%; } @media (max-width: 540px) { div.nbinput.container, div.nboutput.container { flex-direction: column; } } /* input container */ div.nbinput.container { padding-top: 5px; } /* last container */ div.nblast.container { padding-bottom: 5px; } /* input prompt */ div.nbinput.container div.prompt pre { color: #307FC1; } /* output prompt */ div.nboutput.container div.prompt pre { color: #BF5B3D; } /* all prompts */ div.nbinput.container div.prompt, div.nboutput.container div.prompt { width: 4.5ex; padding-top: 5px; position: relative; user-select: none; } div.nbinput.container div.prompt > div, div.nboutput.container div.prompt > div { position: absolute; right: 0; margin-right: 0.3ex; } @media (max-width: 540px) { div.nbinput.container div.prompt, div.nboutput.container div.prompt { width: unset; text-align: left; padding: 0.4em; } div.nboutput.container div.prompt.empty { padding: 0; } div.nbinput.container div.prompt > div, div.nboutput.container div.prompt > div { position: unset; } } /* disable scrollbars on prompts */ div.nbinput.container div.prompt pre, div.nboutput.container div.prompt pre { overflow: hidden; } /* input/output area */ div.nbinput.container div.input_area, div.nboutput.container div.output_area { -webkit-flex: 1; flex: 1; overflow: auto; } @media (max-width: 540px) { div.nbinput.container div.input_area, div.nboutput.container div.output_area { width: 100%; } } /* input area */ div.nbinput.container div.input_area { border: 1px solid #e0e0e0; border-radius: 2px; /*background: #f5f5f5;*/ } /* override MathJax center alignment in output cells */ div.nboutput.container div[class*=MathJax] { text-align: left !important; } /* override sphinx.ext.imgmath center alignment in output cells */ div.nboutput.container div.math p { text-align: left; } /* standard error */ div.nboutput.container div.output_area.stderr { background: #fdd; } /* ANSI colors */ .ansi-black-fg { color: #3E424D; } .ansi-black-bg { background-color: #3E424D; } .ansi-black-intense-fg { color: #282C36; } .ansi-black-intense-bg { background-color: #282C36; } .ansi-red-fg { color: #E75C58; } .ansi-red-bg { background-color: #E75C58; } .ansi-red-intense-fg { color: #B22B31; } .ansi-red-intense-bg { background-color: #B22B31; } .ansi-green-fg { color: #00A250; } .ansi-green-bg { background-color: #00A250; } .ansi-green-intense-fg { color: #007427; } .ansi-green-intense-bg { background-color: #007427; } .ansi-yellow-fg { color: #DDB62B; } .ansi-yellow-bg { background-color: #DDB62B; } .ansi-yellow-intense-fg { color: #B27D12; } .ansi-yellow-intense-bg { background-color: #B27D12; } .ansi-blue-fg { color: #208FFB; } .ansi-blue-bg { background-color: #208FFB; } .ansi-blue-intense-fg { color: #0065CA; } .ansi-blue-intense-bg { background-color: #0065CA; } .ansi-magenta-fg { color: #D160C4; } .ansi-magenta-bg { background-color: #D160C4; } .ansi-magenta-intense-fg { color: #A03196; } .ansi-magenta-intense-bg { background-color: #A03196; } .ansi-cyan-fg { color: #60C6C8; } .ansi-cyan-bg { background-color: #60C6C8; } .ansi-cyan-intense-fg { color: #258F8F; } .ansi-cyan-intense-bg { background-color: #258F8F; } .ansi-white-fg { color: #C5C1B4; } .ansi-white-bg { background-color: #C5C1B4; } .ansi-white-intense-fg { color: #A1A6B2; } .ansi-white-intense-bg { background-color: #A1A6B2; } .ansi-default-inverse-fg { color: #FFFFFF; } .ansi-default-inverse-bg { background-color: #000000; } .ansi-bold { font-weight: bold; } .ansi-underline { text-decoration: underline; } div.nbinput.container div.input_area div[class*=highlight] > pre, div.nboutput.container div.output_area div[class*=highlight] > pre, div.nboutput.container div.output_area div[class*=highlight].math, div.nboutput.container div.output_area.rendered_html, div.nboutput.container div.output_area > div.output_javascript, div.nboutput.container div.output_area:not(.rendered_html) > img{ padding: 5px; margin: 0; } /* fix copybtn overflow problem in chromium (needed for 'sphinx_copybutton') */ div.nbinput.container div.input_area > div[class^='highlight'], div.nboutput.container div.output_area > div[class^='highlight']{ overflow-y: hidden; } /* hide copybtn icon on prompts (needed for 'sphinx_copybutton') */ .prompt .copybtn { display: none; } /* Some additional styling taken form the Jupyter notebook CSS */ .jp-RenderedHTMLCommon table, div.rendered_html table { border: none; border-collapse: collapse; border-spacing: 0; color: black; font-size: 12px; table-layout: fixed; } .jp-RenderedHTMLCommon thead, div.rendered_html thead { border-bottom: 1px solid black; vertical-align: bottom; } .jp-RenderedHTMLCommon tr, .jp-RenderedHTMLCommon th, .jp-RenderedHTMLCommon td, div.rendered_html tr, div.rendered_html th, div.rendered_html td { text-align: right; vertical-align: middle; padding: 0.5em 0.5em; line-height: normal; white-space: normal; max-width: none; border: none; } .jp-RenderedHTMLCommon th, div.rendered_html th { font-weight: bold; } .jp-RenderedHTMLCommon tbody tr:nth-child(odd), div.rendered_html tbody tr:nth-child(odd) { background: #f5f5f5; } .jp-RenderedHTMLCommon tbody tr:hover, div.rendered_html tbody tr:hover { background: rgba(66, 165, 245, 0.2); } </style> <div class="section" id="Compiling-and-Deploying-ResNet50-on-Trn1-or-Inf2"> <h1>Compiling and Deploying ResNet50 on Trn1 or Inf2<a class="headerlink" href="#Compiling-and-Deploying-ResNet50-on-Trn1-or-Inf2" title="Permalink to this headline">#</a></h1> <div class="section" id="Introduction"> <h2>Introduction<a class="headerlink" href="#Introduction" title="Permalink to this headline">#</a></h2> <p>In this tutorial we will compile and deploy a TorchVision ResNet50 model for accelerated inference on Neuron. To get started with Jupyter Notebook on Neuron Instance you launched, please use this <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html">guide</a>.</p> <p>This tutorial will use the <a class="reference external" href="https://pytorch.org/vision/main/models/generated/torchvision.models.resnet50.html">resnet50</a> model, which is primarily used for arbitrary image classification tasks.</p> <p>This tutorial has the following main sections:</p> <ol class="arabic simple"> <li><p>Install dependencies</p></li> <li><p>Compile the ResNet model</p></li> <li><p>Run inference on Neuron and compare results to CPU</p></li> <li><p>Benchmark the model using multicore inference</p></li> <li><p>Finding the optimal batch size</p></li> </ol> <p>This Jupyter notebook should be run on a Trn1 instance (<code class="docutils literal notranslate"><span class="pre">trn1.2xlarge</span></code> or larger.) or Inf2 instance (<code class="docutils literal notranslate"><span class="pre">inf2.xlarge</span></code> or larger.)</p> </div> <div class="section" id="Install-Dependencies"> <h2>Install Dependencies<a class="headerlink" href="#Install-Dependencies" title="Permalink to this headline">#</a></h2> <p>The code in this tutorial is written for Jupyter Notebooks. To use Jupyter Notebook on the Neuron instance, you can use this <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html">guide</a>.</p> <p>This tutorial requires the following pip packages:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">neuronx-cc</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">torchvision</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">Pillow</span></code></p></li> </ul> <p>Most of these packages will be installed when configuring your environment using the Trn1 setup guide. The additional dependencies must be installed here:</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="o">!</span>pip<span class="w"> </span>install<span class="w"> </span>Pillow </pre></div> </div> </div> </div> <div class="section" id="Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript"> <h2>Compile the model into an AWS Neuron optimized TorchScript<a class="headerlink" href="#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript" title="Permalink to this headline">#</a></h2> <p>In the following section, we load the model, get a sample input, run inference on CPU, compile the model for Neuron using <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code>, and save the optimized model as <code class="docutils literal notranslate"><span class="pre">TorchScript</span></code>.</p> <p><code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code> expects a tensor or tuple of tensor inputs to use for tracing, so we convert the input image into a tensor using the <code class="docutils literal notranslate"><span class="pre">get_image</span></code> function.</p> <p>The result of the trace stage will be a static executable where the operations to be run upon inference are determined during compilation. This means that when inferring, the resulting Neuron model must be executed with tensors that are the exact same shape as those provided at compilation time. If a model is given a tensor at inference time whose shape does not match the tensor given at compilation time, an error will occur.</p> <p>In the following section, we assume that we will receive an image shape of <code class="docutils literal notranslate"><span class="pre">[1,</span> <span class="pre">3,</span> <span class="pre">224,</span> <span class="pre">224]</span></code> at inference time.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span> <span class="kn">import</span> <span class="nn">urllib</span> <span class="kn">from</span> <span class="nn">PIL</span> <span class="kn">import</span> <span class="n">Image</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="kn">from</span> <span class="nn">torchvision.transforms</span> <span class="kn">import</span> <span class="n">functional</span> <span class="k">def</span> <span class="nf">get_image</span><span class="p">(</span><span class="n">batch_size</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">image_shape</span><span class="o">=</span><span class="p">(</span><span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">)):</span> <span class="c1"># Get an example input</span> <span class="n">filename</span> <span class="o">=</span> <span class="s2">"000000039769.jpg"</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span> <span class="n">url</span> <span class="o">=</span> <span class="s2">"http://images.cocodataset.org/val2017/000000039769.jpg"</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlretrieve</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> <span class="n">image</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span><span class="o">.</span><span class="n">convert</span><span class="p">(</span><span class="s1">'RGB'</span><span class="p">)</span> <span class="n">image</span> <span class="o">=</span> <span class="n">functional</span><span class="o">.</span><span class="n">resize</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="p">(</span><span class="n">image_shape</span><span class="p">))</span> <span class="n">image</span> <span class="o">=</span> <span class="n">functional</span><span class="o">.</span><span class="n">to_tensor</span><span class="p">(</span><span class="n">image</span><span class="p">)</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">unsqueeze</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">repeat_interleave</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="k">return</span> <span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="p">)</span> <span class="c1"># Create the model</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Get an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">get_image</span><span class="p">()</span> <span class="c1"># Run inference on CPU</span> <span class="n">output_cpu</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="o">*</span><span class="n">image</span><span class="p">)</span> <span class="c1"># Compile the model</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Save the TorchScript for inference deployment</span> <span class="n">filename</span> <span class="o">=</span> <span class="s1">'model.pt'</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="Run-inference-and-compare-results"> <h2>Run inference and compare results<a class="headerlink" href="#Run-inference-and-compare-results" title="Permalink to this headline">#</a></h2> <p>In this section we load the compiled model, run inference on Neuron, and compare the CPU and Neuron outputs using the ImageNet classes.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">json</span> <span class="c1"># Load the TorchScript compiled model</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="c1"># Run inference using the Neuron model</span> <span class="n">output_neuron</span> <span class="o">=</span> <span class="n">model_neuron</span><span class="p">(</span><span class="o">*</span><span class="n">image</span><span class="p">)</span> <span class="c1"># Compare the results</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"CPU tensor: </span><span class="si">{</span><span class="n">output_cpu</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">:</span><span class="mi">10</span><span class="p">]</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Neuron tensor: </span><span class="si">{</span><span class="n">output_neuron</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">:</span><span class="mi">10</span><span class="p">]</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> <span class="c1"># Download and read the ImageNet classes</span> <span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlretrieve</span><span class="p">(</span><span class="s2">"https://s3.amazonaws.com/deep-learning-models/image-models/imagenet_class_index.json"</span><span class="p">,</span><span class="s2">"imagenet_class_index.json"</span><span class="p">)</span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"imagenet_class_index.json"</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span> <span class="n">class_id</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">file</span><span class="p">)</span> <span class="n">id2label</span> <span class="o">=</span> <span class="p">[</span><span class="n">class_id</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">)][</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">class_id</span><span class="p">))]</span> <span class="c1"># Lookup and print the top-5 labels</span> <span class="n">top5_cpu</span> <span class="o">=</span> <span class="n">output_cpu</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">sort</span><span class="p">()[</span><span class="mi">1</span><span class="p">][</span><span class="o">-</span><span class="mi">5</span><span class="p">:]</span> <span class="n">top5_neuron</span> <span class="o">=</span> <span class="n">output_neuron</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">sort</span><span class="p">()[</span><span class="mi">1</span><span class="p">][</span><span class="o">-</span><span class="mi">5</span><span class="p">:]</span> <span class="n">top5_labels_cpu</span> <span class="o">=</span> <span class="p">[</span><span class="n">id2label</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span> <span class="k">for</span> <span class="n">idx</span> <span class="ow">in</span> <span class="n">top5_cpu</span><span class="p">]</span> <span class="n">top5_labels_neuron</span> <span class="o">=</span> <span class="p">[</span><span class="n">id2label</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span> <span class="k">for</span> <span class="n">idx</span> <span class="ow">in</span> <span class="n">top5_neuron</span><span class="p">]</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"CPU top-5 labels: </span><span class="si">{</span><span class="n">top5_labels_cpu</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Neuron top-5 labels: </span><span class="si">{</span><span class="n">top5_labels_neuron</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="Benchmarking"> <h2>Benchmarking<a class="headerlink" href="#Benchmarking" title="Permalink to this headline">#</a></h2> <p>In this section we benchmark the performance of the ResNet model on Neuron. By default, models compiled with <code class="docutils literal notranslate"><span class="pre">torch_neuronx</span></code> will always execute on a <em>single</em> NeuronCore. When loading <em>multiple</em> models, the default behavior of the Neuron runtime is to evenly distribute models across all available NeuronCores. The runtime places models on the NeuronCore that has the fewest models loaded to it first. In the following section, we will <code class="docutils literal notranslate"><span class="pre">torch.jit.load</span></code> multiple instances of the model which should each be loaded onto their own NeuronCore. It is not useful to load more copies of a model than the number of NeuronCores on the instance since an individual NeuronCore can only execute one model at a time.</p> <p>To ensure that we are maximizing hardware utilization, we must run inferences using multiple threads in parallel. It is nearly always recommended to use some form of threading/multiprocessing and some form of model replication since even the smallest Neuron EC2 instance has 2 NeuronCores available. Applications with no form of threading are only capable of <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">/</span> <span class="pre">num_neuron_cores</span></code> hardware utilization which becomes especially problematic on large instances.</p> <p>One way to view the hardware utilization is by executing the <code class="docutils literal notranslate"><span class="pre">neuron-top</span></code> application in the terminal while the benchmark is executing. If the monitor shows &gt;90% utilization on all NeuronCores, this is a good indication that the hardware is being utilized effectively.</p> <p>In this example we load two models, which utilizes all NeuronCores (2) on a <code class="docutils literal notranslate"><span class="pre">trn1.2xlarge</span></code> or <code class="docutils literal notranslate"><span class="pre">inf2.xlarge</span></code> instance. Additional models can be loaded and run in parallel on larger Trn1 or Inf2 instance sizes to increase throughput.</p> <p>We define a benchmarking function that loads two optimized ResNet models onto two separate NeuronCores, runs multithreaded inference, and calculates the corresponding latency and throughput.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">time</span> <span class="kn">import</span> <span class="nn">concurrent.futures</span> <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> <span class="k">def</span> <span class="nf">benchmark</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">example</span><span class="p">,</span> <span class="n">n_models</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">n_threads</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">batches_per_thread</span><span class="o">=</span><span class="mi">1000</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""</span> <span class="sd"> Record performance statistics for a serialized model and its input example.</span> <span class="sd"> Arguments:</span> <span class="sd"> filename: The serialized torchscript model to load for benchmarking.</span> <span class="sd"> example: An example model input.</span> <span class="sd"> n_models: The number of models to load.</span> <span class="sd"> n_threads: The number of simultaneous threads to execute inferences on.</span> <span class="sd"> batches_per_thread: The number of example batches to run per thread.</span> <span class="sd"> Returns:</span> <span class="sd"> A dictionary of performance statistics.</span> <span class="sd"> """</span> <span class="c1"># Load models</span> <span class="n">models</span> <span class="o">=</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n_models</span><span class="p">)]</span> <span class="c1"># Warmup</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">8</span><span class="p">):</span> <span class="k">for</span> <span class="n">model</span> <span class="ow">in</span> <span class="n">models</span><span class="p">:</span> <span class="n">model</span><span class="p">(</span><span class="o">*</span><span class="n">example</span><span class="p">)</span> <span class="n">latencies</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># Thread task</span> <span class="k">def</span> <span class="nf">task</span><span class="p">(</span><span class="n">model</span><span class="p">):</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">batches_per_thread</span><span class="p">):</span> <span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="n">model</span><span class="p">(</span><span class="o">*</span><span class="n">example</span><span class="p">)</span> <span class="n">finish</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="n">latencies</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">finish</span> <span class="o">-</span> <span class="n">start</span><span class="p">)</span> <span class="o">*</span> <span class="mi">1000</span><span class="p">)</span> <span class="c1"># Submit tasks</span> <span class="n">begin</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="k">with</span> <span class="n">concurrent</span><span class="o">.</span><span class="n">futures</span><span class="o">.</span><span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="n">n_threads</span><span class="p">)</span> <span class="k">as</span> <span class="n">pool</span><span class="p">:</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n_threads</span><span class="p">):</span> <span class="n">pool</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">task</span><span class="p">,</span> <span class="n">models</span><span class="p">[</span><span class="n">i</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">models</span><span class="p">)])</span> <span class="n">end</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="c1"># Compute metrics</span> <span class="n">boundaries</span> <span class="o">=</span> <span class="p">[</span><span class="mi">50</span><span class="p">,</span> <span class="mi">95</span><span class="p">,</span> <span class="mi">99</span><span class="p">]</span> <span class="n">percentiles</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">for</span> <span class="n">boundary</span> <span class="ow">in</span> <span class="n">boundaries</span><span class="p">:</span> <span class="n">name</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'latency_p</span><span class="si">{</span><span class="n">boundary</span><span class="si">}</span><span class="s1">'</span> <span class="n">percentiles</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">percentile</span><span class="p">(</span><span class="n">latencies</span><span class="p">,</span> <span class="n">boundary</span><span class="p">)</span> <span class="n">duration</span> <span class="o">=</span> <span class="n">end</span> <span class="o">-</span> <span class="n">begin</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">for</span> <span class="n">tensor</span> <span class="ow">in</span> <span class="n">example</span><span class="p">:</span> <span class="k">if</span> <span class="n">batch_size</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="n">tensor</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="n">inferences</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">latencies</span><span class="p">)</span> <span class="o">*</span> <span class="n">batch_size</span> <span class="n">throughput</span> <span class="o">=</span> <span class="n">inferences</span> <span class="o">/</span> <span class="n">duration</span> <span class="c1"># Metrics</span> <span class="n">metrics</span> <span class="o">=</span> <span class="p">{</span> <span class="s1">'filename'</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">filename</span><span class="p">),</span> <span class="s1">'batch_size'</span><span class="p">:</span> <span class="n">batch_size</span><span class="p">,</span> <span class="s1">'batches'</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">latencies</span><span class="p">),</span> <span class="s1">'inferences'</span><span class="p">:</span> <span class="n">inferences</span><span class="p">,</span> <span class="s1">'threads'</span><span class="p">:</span> <span class="n">n_threads</span><span class="p">,</span> <span class="s1">'models'</span><span class="p">:</span> <span class="n">n_models</span><span class="p">,</span> <span class="s1">'duration'</span><span class="p">:</span> <span class="n">duration</span><span class="p">,</span> <span class="s1">'throughput'</span><span class="p">:</span> <span class="n">throughput</span><span class="p">,</span> <span class="o">**</span><span class="n">percentiles</span><span class="p">,</span> <span class="p">}</span> <span class="n">display</span><span class="p">(</span><span class="n">metrics</span><span class="p">)</span> <span class="k">def</span> <span class="nf">display</span><span class="p">(</span><span class="n">metrics</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""</span> <span class="sd"> Display the metrics produced by `benchmark` function.</span> <span class="sd"> Args:</span> <span class="sd"> metrics: A dictionary of performance statistics.</span> <span class="sd"> """</span> <span class="n">pad</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">len</span><span class="p">,</span> <span class="n">metrics</span><span class="p">))</span> <span class="o">+</span> <span class="mi">1</span> <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">metrics</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> <span class="n">parts</span> <span class="o">=</span> <span class="n">key</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'_'</span><span class="p">)</span> <span class="n">parts</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">title</span><span class="p">,</span> <span class="n">parts</span><span class="p">))</span> <span class="n">title</span> <span class="o">=</span> <span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">parts</span><span class="p">)</span> <span class="o">+</span> <span class="s2">":"</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">float</span><span class="p">):</span> <span class="n">value</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="n">value</span><span class="si">:</span><span class="s1">0.3f</span><span class="si">}</span><span class="s1">'</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="n">title</span><span class="w"> </span><span class="si">:</span><span class="s1">&lt;</span><span class="si">{</span><span class="n">pad</span><span class="si">}}</span><span class="s1"> </span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span> <span class="c1"># Benchmark ResNet on Neuron</span> <span class="n">benchmark</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="Finding-the-optimal-batch-size"> <h2>Finding the optimal batch size<a class="headerlink" href="#Finding-the-optimal-batch-size" title="Permalink to this headline">#</a></h2> <p>Batch size has a direct impact on model performance. The NeuronCore architecture is optimized to maximize throughput with relatively small batch sizes. This means that a Neuron compiled model can outperform a GPU model, even if running single digit batch sizes.</p> <p>As a general best practice, we recommend optimizing your model’s throughput by compiling the model with a small batch size and gradually increasing it to find the peak throughput on Neuron. To minimize latency, using <code class="docutils literal notranslate"><span class="pre">batch</span> <span class="pre">size</span> <span class="pre">=</span> <span class="pre">1</span></code> will nearly always be optimal. This batch size configuration is typically used for on-demand inference applications. To maximize throughput, <em>usually</em> <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">&lt;</span> <span class="pre">batch_size</span> <span class="pre">&lt;</span> <span class="pre">10</span></code> is optimal. A configuration which uses a larger batch size is generally ideal for batched on-demand inference or offline batch processing.</p> <p>In the following section, we compile ResNet for multiple batch size inputs. We then run inference on each batch size and benchmark the performance. Notice that latency increases consistently as the batch size increases. Throughput increases as well, up until a certain point where the input size becomes too large to be efficient.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Compile ResNet for different batch sizes</span> <span class="k">for</span> <span class="n">batch_size</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">10</span><span class="p">]:</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">example</span> <span class="o">=</span> <span class="n">get_image</span><span class="p">(</span><span class="n">batch_size</span><span class="o">=</span><span class="n">batch_size</span><span class="p">)</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example</span><span class="p">)</span> <span class="n">filename</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'model_batch_size_</span><span class="si">{</span><span class="n">batch_size</span><span class="si">}</span><span class="s1">.pt'</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> </pre></div> </div> </div> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Benchmark ResNet for different batch sizes</span> <span class="k">for</span> <span class="n">batch_size</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">,</span> <span class="mi">10</span><span class="p">]:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'-'</span><span class="o">*</span><span class="mi">50</span><span class="p">)</span> <span class="n">example</span> <span class="o">=</span> <span class="n">get_image</span><span class="p">(</span><span class="n">batch_size</span><span class="o">=</span><span class="n">batch_size</span><span class="p">)</span> <span class="n">filename</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'model_batch_size_</span><span class="si">{</span><span class="n">batch_size</span><span class="si">}</span><span class="s1">.pt'</span> <span class="n">benchmark</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">example</span><span class="p">)</span> <span class="nb">print</span><span class="p">()</span> </pre></div> </div> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">LibTorch C++ Tutorial</p> </div> </a> <a class="right-next" id="next-link" href="t5-inference-tutorial.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">T5 model inference on Trn1 or Inf2</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:46.919Z
T5 model inference on Trn1 or Inf2 — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html
# T5 model inference on Trn1 or Inf2 — AWS Neuron Documentation ``` import torch import torch_xla.core.xla_model as xm from transformers import T5Tokenizer, T5ForConditionalGeneration from transformers.modeling_outputs import BaseModelOutput, Seq2SeqLMOutput from transformers.models.t5.modeling_t5 import T5Stack, T5LayerCrossAttention from transformers.generation.utils import ModelOutput from typing import Any, Dict, List, Optional, Tuple, Union from transformers.generation.beam_search import BeamScorer, BeamSearchScorer from optimum.neuron.generation import NeuronGenerationMixin from transformers.generation.logits_process import ( LogitsProcessorList, ) from transformers.generation.stopping_criteria import ( MaxLengthCriteria, MaxTimeCriteria, StoppingCriteriaList, validate_stopping_criteria, ) from transformers.generation.utils import ( BeamSearchOutput, GreedySearchOutput, ) class T5Wrapper(T5ForConditionalGeneration, NeuronGenerationMixin): def _prepare_encoder_decoder_kwargs_for_generation( self, inputs_tensor: torch.Tensor, model_kwargs, model_input_name: Optional[str] = None ) -> Dict[str, Any]: encoder = self.get_encoder() model_kwargs["encoder_outputs"]: ModelOutput = encoder(inputs_tensor, model_kwargs["attention_mask"]) return model_kwargs # Override to cut the input_ids to just last token def prepare_inputs_for_generation( self, input_ids, past_key_values=None, attention_mask=None, head_mask=None, decoder_head_mask=None, decoder_attention_mask=None, cross_attn_head_mask=None, use_cache=None, encoder_outputs=None, **kwargs, ): # cut decoder_input_ids as past is cached input_ids = input_ids[:, -1:] return { "decoder_input_ids": input_ids, "past_key_values": past_key_values, "encoder_outputs": encoder_outputs, "attention_mask": attention_mask, "head_mask": head_mask, "decoder_head_mask": decoder_head_mask, "decoder_attention_mask": decoder_attention_mask, "cross_attn_head_mask": cross_attn_head_mask, "use_cache": use_cache, } ''' We update the cache in the decoder trace, so lets override the _update_model_kwargs_for_xla_generation in NeuronGenerationMixin ''' def _update_model_kwargs_for_xla_generation( self, model_kwargs: Dict[str, Any], batch_size: int, is_encoder_decoder: bool = False, standardize_cache_format: bool = False, max_length: Optional[int] = None, seq_length: Optional[int] = None, use_cache: bool = True, ) -> Dict[str, Any]: def _update_attention(model_kwargs, is_encoder_decoder): """Updates the appropriate attention mask -- encoder-decoder models use `decoder_attention_mask`""" attention_mask_name = "decoder_attention_mask" if is_encoder_decoder else "attention_mask" attention_mask = model_kwargs.pop(attention_mask_name) attention_mask_update_slice = torch.ones( (batch_size, 1), dtype=attention_mask.dtype, device=attention_mask.device ) attention_mask = torch.cat([attention_mask[:, 1:], attention_mask_update_slice], dim=-1) mask = {attention_mask_name: attention_mask} return mask mask = _update_attention(model_kwargs, is_encoder_decoder) # sets the updated variables (mask and past_key_values) model_kwargs.update(mask) # Set a mock cache tensor model_kwargs["past_key_values"] = torch.tensor([]) return model_kwargs def _reorder_cache(self, past_key_values, beam_idx): ''' This is needed for beam search and not greedy sampling We reorder the cache within the trace so we can skip it in modelling_t5.py. So we override the _reorder_cache ''' self.beam_idx = beam_idx return past_key_values def generate(self, tokenizer: T5Tokenizer, prompt: str, max_length: int, num_beams: int, num_return_sequences: int, device: str): batch_encoding = tokenizer(prompt, max_length=max_length, truncation=True, padding='max_length', return_tensors="pt") past_key_values = self.encoder(batch_encoding['input_ids'],batch_encoding['attention_mask']) decoder_attention_mask = torch.cat([torch.zeros((1, max_length-1), dtype=torch.int32), torch.ones((1, 1), dtype=torch.int32)], axis=1) # copy the new cache state to the decoder if device == "xla": for state, tensor in zip(self.decoder.parameters(), past_key_values): state.copy_(tensor) else: # First half of the cache is self attention and the rest is cross attention self.decoder.past_key_values_sa = past_key_values[:len(past_key_values)//2] self.decoder.past_key_values_ca = past_key_values[len(past_key_values)//2:] output = super().generate(**batch_encoding, max_length=max_length, num_beams=num_beams, num_return_sequences=num_return_sequences, do_sample=False, use_cache=True, decoder_attention_mask=decoder_attention_mask, encoder_outputs={"last_hidden_state": torch.ones((1,128,1))}) # Pass fake encoder_outputs so the transfomers code will not invoke the encoder return output def forward( self, attention_mask: Optional[torch.FloatTensor] = None, decoder_input_ids: Optional[torch.LongTensor] = None, decoder_attention_mask: Optional[torch.BoolTensor] = None, encoder_outputs: Optional[Tuple[Tuple[torch.Tensor]]] = None, beam_scores = None, **kwargs ) -> Union[Tuple[torch.FloatTensor], Seq2SeqLMOutput]: hidden_states = encoder_outputs["last_hidden_state"] if not hasattr(self, 'beam_idx'): # Infering the number of beams from the attention mask num_beams = attention_mask.shape[0] self.beam_idx = torch.arange(0, num_beams, dtype=torch.int64) decoder_outputs = self.decoder( decoder_input_ids, decoder_attention_mask, hidden_states, attention_mask, self.beam_idx, beam_scores ) # lm_logits = decoder_outputs[0] next_token_scores = decoder_outputs[0] next_tokens = decoder_outputs[1] next_indices = decoder_outputs[2] return next_token_scores, next_tokens, next_indices def beam_search( self, input_ids: torch.LongTensor, beam_scorer: BeamScorer, logits_processor: Optional[LogitsProcessorList] = None, stopping_criteria: Optional[StoppingCriteriaList] = None, max_length: Optional[int] = None, pad_token_id: Optional[int] = None, eos_token_id: Optional[Union[int, List[int]]] = None, output_attentions: Optional[bool] = None, output_hidden_states: Optional[bool] = None, output_scores: Optional[bool] = None, return_dict_in_generate: Optional[bool] = None, synced_gpus: Optional[bool] = False, seq_length: Optional[int] = None, **model_kwargs, ) -> Union[BeamSearchOutput, torch.LongTensor]: logits_processor = logits_processor if logits_processor is not None else LogitsProcessorList() stopping_criteria = stopping_criteria if stopping_criteria is not None else StoppingCriteriaList() pad_token_id = pad_token_id if pad_token_id is not None else self.generation_config.pad_token_id eos_token_id = eos_token_id if eos_token_id is not None else self.generation_config.eos_token_id if isinstance(eos_token_id, int): eos_token_id = [eos_token_id] output_scores = output_scores if output_scores is not None else self.generation_config.output_scores output_attentions = ( output_attentions if output_attentions is not None else self.generation_config.output_attentions ) output_hidden_states = ( output_hidden_states if output_hidden_states is not None else self.generation_config.output_hidden_states ) batch_size = len(beam_scorer._beam_hyps) num_beams = beam_scorer.num_beams batch_beam_size, cur_len = input_ids.shape # Overwrite cur_len cur_len = seq_length if num_beams * batch_size != batch_beam_size: raise ValueError( f"Batch dimension of `input_ids` should be {num_beams * batch_size}, but is {batch_beam_size}." ) # init attention / hidden states / scores tuples scores = () if (return_dict_in_generate and output_scores) else None beam_indices = ( tuple(() for _ in range(batch_beam_size)) if (return_dict_in_generate and output_scores) else None ) # initialise score of first beam with 0 and the rest with -1e9. This makes sure that only tokens # of the first beam are considered to avoid sampling the exact same tokens across all beams. # beam_scores = torch.zeros((batch_size, num_beams), dtype=torch.float, device=input_ids.device) beam_scores_device = "cpu" beam_scores = torch.zeros((batch_size, num_beams), dtype=torch.float, device=beam_scores_device) beam_scores[:, 1:] = -1e9 beam_scores = beam_scores.view((batch_size * num_beams,)) while True: # prepare model inputs # From max_length-sized input_ids, select first # cur_len - 1 values. update_indices = torch.stack( [torch.arange(input_ids.size(0)), torch.tensor(cur_len - 1).repeat(input_ids.size(0))], dim=-1 ) input_ids_ = input_ids[update_indices[:, 0], update_indices[:, 1], None] model_inputs = self.prepare_inputs_for_generation(input_ids_, **model_kwargs) next_token_scores, next_tokens, next_indices = self( **model_inputs, return_dict=True, output_attentions=output_attentions, output_hidden_states=output_hidden_states, beam_scores=beam_scores ) # stateless beam_outputs = beam_scorer.process( input_ids.to("cpu")[:, :cur_len], next_token_scores.to("cpu"), next_tokens.to("cpu"), next_indices.to("cpu"), pad_token_id=pad_token_id, eos_token_id=eos_token_id, beam_indices=beam_indices, ) beam_scores = beam_outputs["next_beam_scores"] beam_next_tokens = beam_outputs["next_beam_tokens"] beam_idx = beam_outputs["next_beam_indices"] update_indices = torch.stack( [torch.arange(batch_beam_size), torch.tensor(cur_len - 1).repeat(batch_beam_size)], dim=-1 ) update_indices_2 = torch.stack( [torch.arange(batch_beam_size), torch.tensor(cur_len).repeat(batch_beam_size)], dim=-1 ) # First select beam_indices device = input_ids.device beam_idx_device = beam_idx.to(device=input_ids.device) input_ids[:, :] = input_ids[beam_idx_device.long(), :] # Then append new tokens input_ids[update_indices_2[:, 0], update_indices_2[:, 1], None] = beam_next_tokens.unsqueeze(-1).to(device).to(torch.long) input_ids = input_ids * 1 # Hack to materialize tensor # update generated ids, model inputs, and length for next step model_kwargs = self._update_model_kwargs_for_xla_generation( model_kwargs, batch_size=batch_beam_size, is_encoder_decoder=self.config.is_encoder_decoder, max_length=stopping_criteria.max_length, seq_length=cur_len, use_cache=model_kwargs["use_cache"], ) if model_kwargs["past_key_values"] is not None: model_kwargs["past_key_values"] = self._reorder_cache(model_kwargs["past_key_values"], beam_idx.to(torch.int64)) if return_dict_in_generate and output_scores: beam_indices = tuple((beam_indices[beam_idx[i]] + (beam_idx[i],) for i in range(len(beam_indices)))) # increase cur_len cur_len = cur_len + 1 # stop when each sentence is finished, or if we exceed the maximum length stop_criterion_1 = beam_scorer.is_done if isinstance(stopping_criteria, list): if len(stopping_criteria) == 1: stopping_criteria = stopping_criteria[0] # Cases that can be handled in XLA without requiring # non-padded input_ids if isinstance(stopping_criteria, MaxLengthCriteria): stop_criterion_2 = cur_len >= stopping_criteria.max_length elif isinstance(stopping_criteria, MaxTimeCriteria): stop_criterion_2 = stopping_criteria(input_ids, scores) else: # Other cases will be handled on CPU batch_size, _ = input_ids.shape input_ids_cpu = input_ids.to("cpu") mask = torch.cat( [torch.ones(batch_size, cur_len), torch.zeros(batch_size, input_ids.shape[1] - cur_len)], dim=1 ).bool() input_ids_cpu = torch.masked_select(input_ids_cpu, mask).reshape((batch_size, cur_len)) scores_cpu = scores.to("cpu") if torch.is_tensor(scores) else scores stop_criterion_2 = stopping_criteria(input_ids_cpu, scores_cpu) if stop_criterion_1 or stop_criterion_2: if not synced_gpus: break else: this_peer_finished = True sequence_outputs = beam_scorer.finalize( input_ids.to("cpu"), beam_scores.to("cpu"), next_tokens.to("cpu"), next_indices.to("cpu"), pad_token_id=pad_token_id, eos_token_id=eos_token_id, max_length=stopping_criteria.max_length, beam_indices=beam_indices, ) for k, v in sequence_outputs.items(): if type(v) == torch.Tensor: sequence_outputs[k] = sequence_outputs[k].to(input_ids.device) return sequence_outputs["sequences"] def greedy_search( self, input_ids: torch.LongTensor, logits_processor: Optional[LogitsProcessorList] = None, stopping_criteria: Optional[StoppingCriteriaList] = None, max_length: Optional[int] = None, pad_token_id: Optional[int] = None, eos_token_id: Optional[Union[int, List[int]]] = None, output_attentions: Optional[bool] = None, output_hidden_states: Optional[bool] = None, output_scores: Optional[bool] = None, return_dict_in_generate: Optional[bool] = None, seq_length: Optional[int] = int, streamer: Optional["BaseStreamer"] = None, **model_kwargs, ) -> Union[GreedySearchOutput, torch.LongTensor]: """ Overriding greedy sampling to use next tokens returned from neuron device instead of logits. """ # init values logits_processor = logits_processor if logits_processor is not None else LogitsProcessorList() use_cache = model_kwargs["use_cache"] if "use_cache" in model_kwargs else False stopping_criteria = stopping_criteria if stopping_criteria is not None else StoppingCriteriaList() pad_token_id = pad_token_id if pad_token_id is not None else self.generation_config.pad_token_id eos_token_id = eos_token_id if eos_token_id is not None else self.generation_config.eos_token_id if isinstance(eos_token_id, int): eos_token_id = [eos_token_id] eos_token_id_tensor = torch.tensor(eos_token_id).to(input_ids.device) if eos_token_id is not None else None output_scores = output_scores if output_scores is not None else self.generation_config.output_scores output_attentions = ( output_attentions if output_attentions is not None else self.generation_config.output_attentions ) output_hidden_states = ( output_hidden_states if output_hidden_states is not None else self.generation_config.output_hidden_states ) # init attention / hidden states / scores tuples scores = () if (return_dict_in_generate and output_scores) else None decoder_attentions = () if (return_dict_in_generate and output_attentions) else None cross_attentions = () if (return_dict_in_generate and output_attentions) else None decoder_hidden_states = () if (return_dict_in_generate and output_hidden_states) else None # keep track of which sequences are already finished unfinished_sequences = torch.ones(input_ids.shape[0], dtype=torch.long, device=input_ids.device) this_peer_finished = False # used by synced_gpus only while True: # prepare model inputs # From max_length-sized input_ids, select first # seq_length - 1 values. if model_kwargs.get("past_key_values") is None: input_ids_ = input_ids[:, :seq_length] else: update_indices = torch.stack( [torch.arange(input_ids.size(0)), torch.tensor(seq_length - 1).repeat(input_ids.size(0))], dim=-1, ) input_ids_ = input_ids[update_indices[:, 0], update_indices[:, 1], None] model_inputs = self.prepare_inputs_for_generation(input_ids_, **model_kwargs) # forward pass to get next token output = self( **model_inputs, return_dict=True, output_attentions=output_attentions, output_hidden_states=output_hidden_states, ) next_tokens = output[0] # finished sentences should have their next token be a padding token if eos_token_id is not None: if pad_token_id is None: raise ValueError("If `eos_token_id` is defined, make sure that `pad_token_id` is defined.") next_tokens = next_tokens * unfinished_sequences + pad_token_id * (1 - unfinished_sequences) # update generated ids, model inputs, and length for next step batch_size, _ = input_ids.shape update_indices = torch.stack( [torch.arange(batch_size), torch.tensor(seq_length).repeat(batch_size)], dim=-1 ) input_ids[update_indices[:, 0], update_indices[:, 1]] = next_tokens[:] model_kwargs = self._update_model_kwargs_for_xla_generation( model_kwargs, batch_size=batch_size, is_encoder_decoder=self.config.is_encoder_decoder, max_length=stopping_criteria.max_length, seq_length=seq_length, use_cache=use_cache, ) seq_length += 1 # if eos_token was found in one sentence, set sentence to finished if eos_token_id_tensor is not None: unfinished_sequences = unfinished_sequences.mul( next_tokens.tile(eos_token_id_tensor.shape[0], 1).ne(eos_token_id_tensor.unsqueeze(1)).prod(dim=0) ) # stop when each sentence is finished, or if we exceed the maximum length stop_criterion_1 = unfinished_sequences.max() == 0 if isinstance(stopping_criteria, list): if len(stopping_criteria) == 1: stopping_criteria = stopping_criteria[0] # Cases that can be handled in XLA without requiring # non-padded input_ids if isinstance(stopping_criteria, MaxLengthCriteria): stop_criterion_2 = seq_length >= stopping_criteria.max_length elif isinstance(stopping_criteria, MaxTimeCriteria): stop_criterion_2 = stopping_criteria(input_ids, scores) else: # Other cases will be handled on CPU batch_size, _ = input_ids.shape mask = torch.cat( [torch.ones(batch_size, seq_length), torch.zeros(batch_size, input_ids.shape[1] - seq_length)], dim=1, ).bool() input_ids_cpu = torch.masked_select(input_ids, mask).reshape((batch_size, seq_length)).to("cpu") scores_cpu = scores.to("cpu") if torch.is_tensor(scores) else scores stop_criterion_2 = stopping_criteria(input_ids_cpu, scores_cpu) if stop_criterion_1 or stop_criterion_2: this_peer_finished = True if this_peer_finished: break if streamer is not None: streamer.end() return input_ids ```
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>T5 model inference on Trn1 or Inf2 — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script>window.MathJax = {"tex": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true}, "options": {"ignoreHtmlClass": "tex2jax_ignore|mathjax_ignore|document", "processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script> <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Additional Examples (torch-neuronx)" href="../../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> <link rel="prev" title="Compiling and Deploying ResNet50 on Trn1 or Inf2" href="resnet50-inference-on-trn1-tutorial.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "src/examples/pytorch/torch-neuronx/t5-inference-tutorial", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".ipynb", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <style type="text/css">.CtxtMenu_InfoClose { top:.2em; right:.2em;} .CtxtMenu_InfoContent { overflow:auto; text-align:left; font-size:80%; padding:.4em .6em; border:1px inset; margin:1em 0px; max-height:20em; max-width:30em; background-color:#EEEEEE; white-space:normal;} .CtxtMenu_Info.CtxtMenu_MousePost {outline:none;} .CtxtMenu_Info { position:fixed; left:50%; width:auto; text-align:center; border:3px outset; padding:1em 2em; background-color:#DDDDDD; color:black; cursor:default; font-family:message-box; font-size:120%; font-style:normal; text-indent:0; text-transform:none; line-height:normal; letter-spacing:normal; word-spacing:normal; word-wrap:normal; white-space:nowrap; float:none; z-index:201; border-radius: 15px; /* Opera 10.5 and IE9 */ -webkit-border-radius:15px; /* Safari and Chrome */ -moz-border-radius:15px; /* Firefox */ -khtml-border-radius:15px; /* Konqueror */ box-shadow:0px 10px 20px #808080; /* Opera 10.5 and IE9 */ -webkit-box-shadow:0px 10px 20px #808080; /* Safari 3 & Chrome */ -moz-box-shadow:0px 10px 20px #808080; /* Forefox 3.5 */ -khtml-box-shadow:0px 10px 20px #808080; /* Konqueror */ filter:progid:DXImageTransform.Microsoft.dropshadow(OffX=2, OffY=2, Color="gray", Positive="true"); /* IE */} </style><style type="text/css">.CtxtMenu_MenuClose { position:absolute; cursor:pointer; display:inline-block; border:2px solid #AAA; border-radius:18px; -webkit-border-radius: 18px; /* Safari and Chrome */ -moz-border-radius: 18px; /* Firefox */ -khtml-border-radius: 18px; /* Konqueror */ font-family: "Courier New", Courier; font-size:24px; color:#F0F0F0} .CtxtMenu_MenuClose span { display:block; background-color:#AAA; border:1.5px solid; border-radius:18px; -webkit-border-radius: 18px; /* Safari and Chrome */ -moz-border-radius: 18px; /* Firefox */ -khtml-border-radius: 18px; /* Konqueror */ line-height:0; padding:8px 0 6px /* may need to be browser-specific */} .CtxtMenu_MenuClose:hover { color:white!important; border:2px solid #CCC!important} .CtxtMenu_MenuClose:hover span { background-color:#CCC!important} .CtxtMenu_MenuClose:hover:focus { outline:none} </style><style type="text/css">.CtxtMenu_Menu { position:absolute; background-color:white; color:black; width:auto; padding:5px 0px; border:1px solid #CCCCCC; margin:0; cursor:default; font: menu; text-align:left; text-indent:0; text-transform:none; line-height:normal; letter-spacing:normal; word-spacing:normal; word-wrap:normal; white-space:nowrap; float:none; z-index:201; border-radius: 5px; /* Opera 10.5 and IE9 */ -webkit-border-radius: 5px; /* Safari and Chrome */ -moz-border-radius: 5px; /* Firefox */ -khtml-border-radius: 5px; /* Konqueror */ box-shadow:0px 10px 20px #808080; /* Opera 10.5 and IE9 */ -webkit-box-shadow:0px 10px 20px #808080; /* Safari 3 & Chrome */ -moz-box-shadow:0px 10px 20px #808080; /* Forefox 3.5 */ -khtml-box-shadow:0px 10px 20px #808080; /* Konqueror */} .CtxtMenu_MenuItem { padding: 1px 2em; background:transparent;} .CtxtMenu_MenuArrow { position:absolute; right:.5em; padding-top:.25em; color:#666666; font-family: null; font-size: .75em} .CtxtMenu_MenuActive .CtxtMenu_MenuArrow {color:white} .CtxtMenu_MenuArrow.CtxtMenu_RTL {left:.5em; right:auto} .CtxtMenu_MenuCheck { position:absolute; left:.7em; font-family: null} .CtxtMenu_MenuCheck.CtxtMenu_RTL { right:.7em; left:auto } .CtxtMenu_MenuRadioCheck { position:absolute; left: .7em;} .CtxtMenu_MenuRadioCheck.CtxtMenu_RTL { right: .7em; left:auto} .CtxtMenu_MenuInputBox { padding-left: 1em; right:.5em; color:#666666; font-family: null;} .CtxtMenu_MenuInputBox.CtxtMenu_RTL { left: .1em;} .CtxtMenu_MenuComboBox { left:.1em; padding-bottom:.5em;} .CtxtMenu_MenuSlider { left: .1em;} .CtxtMenu_SliderValue { position:absolute; right:.1em; padding-top:.25em; color:#333333; font-size: .75em} .CtxtMenu_SliderBar { outline: none; background: #d3d3d3} .CtxtMenu_MenuLabel { padding: 1px 2em 3px 1.33em; font-style:italic} .CtxtMenu_MenuRule { border-top: 1px solid #DDDDDD; margin: 4px 3px;} .CtxtMenu_MenuDisabled { color:GrayText} .CtxtMenu_MenuActive { background-color: #606872; color: white;} .CtxtMenu_MenuDisabled:focus { background-color: #E8E8E8} .CtxtMenu_MenuLabel:focus { background-color: #E8E8E8} .CtxtMenu_ContextMenu:focus { outline:none} .CtxtMenu_ContextMenu .CtxtMenu_MenuItem:focus { outline:none} .CtxtMenu_SelectionMenu { position:relative; float:left; border-bottom: none; -webkit-box-shadow:none; -webkit-border-radius:0px; } .CtxtMenu_SelectionItem { padding-right: 1em;} .CtxtMenu_Selection { right: 40%; width:50%; } .CtxtMenu_SelectionBox { padding: 0em; max-height:20em; max-width: none; background-color:#FFFFFF;} .CtxtMenu_SelectionDivider { clear: both; border-top: 2px solid #000000;} .CtxtMenu_Menu .CtxtMenu_MenuClose { top:-10px; left:-10px} </style><style id="MJX-CHTML-styles"> mjx-container[jax="CHTML"] { line-height: 0; } mjx-container [space="1"] { margin-left: .111em; } mjx-container [space="2"] { margin-left: .167em; } mjx-container [space="3"] { margin-left: .222em; } mjx-container [space="4"] { margin-left: .278em; } mjx-container [space="5"] { margin-left: .333em; } mjx-container [rspace="1"] { margin-right: .111em; } mjx-container [rspace="2"] { margin-right: .167em; } mjx-container [rspace="3"] { margin-right: .222em; } mjx-container [rspace="4"] { margin-right: .278em; } mjx-container [rspace="5"] { margin-right: .333em; } mjx-container [size="s"] { font-size: 70.7%; } mjx-container [size="ss"] { font-size: 50%; } mjx-container [size="Tn"] { font-size: 60%; } mjx-container [size="sm"] { font-size: 85%; } mjx-container [size="lg"] { font-size: 120%; } mjx-container [size="Lg"] { font-size: 144%; } mjx-container [size="LG"] { font-size: 173%; } mjx-container [size="hg"] { font-size: 207%; } mjx-container [size="HG"] { font-size: 249%; } mjx-container [width="full"] { width: 100%; } mjx-box { display: inline-block; } mjx-block { display: block; } mjx-itable { display: inline-table; } mjx-row { display: table-row; } mjx-row > * { display: table-cell; } mjx-mtext { display: inline-block; } mjx-mstyle { display: inline-block; } mjx-merror { display: inline-block; color: red; background-color: yellow; } mjx-mphantom { visibility: hidden; } _::-webkit-full-page-media, _:future, :root mjx-container { will-change: opacity; } mjx-assistive-mml { position: absolute !important; top: 0px; left: 0px; clip: rect(1px, 1px, 1px, 1px); padding: 1px 0px 0px 0px !important; border: 0px !important; display: block !important; width: auto !important; overflow: hidden !important; -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } mjx-assistive-mml[display="block"] { width: 100% !important; } mjx-c::before { display: block; width: 0; } .MJX-TEX { font-family: MJXZERO, MJXTEX; } .TEX-B { font-family: MJXZERO, MJXTEX-B; } .TEX-I { font-family: MJXZERO, MJXTEX-I; } .TEX-MI { font-family: MJXZERO, MJXTEX-MI; } .TEX-BI { font-family: MJXZERO, MJXTEX-BI; } .TEX-S1 { font-family: MJXZERO, MJXTEX-S1; } .TEX-S2 { font-family: MJXZERO, MJXTEX-S2; } .TEX-S3 { font-family: MJXZERO, MJXTEX-S3; } .TEX-S4 { font-family: MJXZERO, MJXTEX-S4; } .TEX-A { font-family: MJXZERO, MJXTEX-A; } .TEX-C { font-family: MJXZERO, MJXTEX-C; } .TEX-CB { font-family: MJXZERO, MJXTEX-CB; } .TEX-FR { font-family: MJXZERO, MJXTEX-FR; } .TEX-FRB { font-family: MJXZERO, MJXTEX-FRB; } .TEX-SS { font-family: MJXZERO, MJXTEX-SS; } .TEX-SSB { font-family: MJXZERO, MJXTEX-SSB; } .TEX-SSI { font-family: MJXZERO, MJXTEX-SSI; } .TEX-SC { font-family: MJXZERO, MJXTEX-SC; } .TEX-T { font-family: MJXZERO, MJXTEX-T; } .TEX-V { font-family: MJXZERO, MJXTEX-V; } .TEX-VB { font-family: MJXZERO, MJXTEX-VB; } mjx-stretchy-v mjx-c, mjx-stretchy-h mjx-c { font-family: MJXZERO, MJXTEX-S1, MJXTEX-S4, MJXTEX, MJXTEX-A ! important; } @font-face /* 0 */ { font-family: MJXZERO; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Zero.woff") format("woff"); } @font-face /* 1 */ { font-family: MJXTEX; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Regular.woff") format("woff"); } @font-face /* 2 */ { font-family: MJXTEX-B; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Bold.woff") format("woff"); } @font-face /* 3 */ { font-family: MJXTEX-I; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Math-Italic.woff") format("woff"); } @font-face /* 4 */ { font-family: MJXTEX-MI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Italic.woff") format("woff"); } @font-face /* 5 */ { font-family: MJXTEX-BI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Math-BoldItalic.woff") format("woff"); } @font-face /* 6 */ { font-family: MJXTEX-S1; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size1-Regular.woff") format("woff"); } @font-face /* 7 */ { font-family: MJXTEX-S2; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size2-Regular.woff") format("woff"); } @font-face /* 8 */ { font-family: MJXTEX-S3; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size3-Regular.woff") format("woff"); } @font-face /* 9 */ { font-family: MJXTEX-S4; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size4-Regular.woff") format("woff"); } @font-face /* 10 */ { font-family: MJXTEX-A; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_AMS-Regular.woff") format("woff"); } @font-face /* 11 */ { font-family: MJXTEX-C; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Regular.woff") format("woff"); } @font-face /* 12 */ { font-family: MJXTEX-CB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Bold.woff") format("woff"); } @font-face /* 13 */ { font-family: MJXTEX-FR; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Regular.woff") format("woff"); } @font-face /* 14 */ { font-family: MJXTEX-FRB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Bold.woff") format("woff"); } @font-face /* 15 */ { font-family: MJXTEX-SS; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Regular.woff") format("woff"); } @font-face /* 16 */ { font-family: MJXTEX-SSB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Bold.woff") format("woff"); } @font-face /* 17 */ { font-family: MJXTEX-SSI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Italic.woff") format("woff"); } @font-face /* 18 */ { font-family: MJXTEX-SC; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Script-Regular.woff") format("woff"); } @font-face /* 19 */ { font-family: MJXTEX-T; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Typewriter-Regular.woff") format("woff"); } @font-face /* 20 */ { font-family: MJXTEX-V; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Regular.woff") format("woff"); } @font-face /* 21 */ { font-family: MJXTEX-VB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Bold.woff") format("woff"); } </style><script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fsrc/examples/pytorch/torch-neuronx/t5-inference-tutorial.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/src/examples/pytorch/torch-neuronx/t5-inference-tutorial.ipynb" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/src/examples/pytorch/torch-neuronx/t5-inference-tutorial.ipynb.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.ipynb</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Install-dependencies"> Install dependencies </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript"> Compile the model into an AWS Neuron optimized TorchScript </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-inference-with-greedy-decoding"> Run inference with greedy decoding </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-inference-with-beam-search"> Run inference with beam search </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>T5 model inference on Trn1 or Inf2</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Install-dependencies"> Install dependencies </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript"> Compile the model into an AWS Neuron optimized TorchScript </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-inference-with-greedy-decoding"> Run inference with greedy decoding </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-inference-with-beam-search"> Run inference with beam search </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <style> /* CSS for nbsphinx extension */ /* remove conflicting styling from Sphinx themes */ div.nbinput.container div.prompt *, div.nboutput.container div.prompt *, div.nbinput.container div.input_area pre, div.nboutput.container div.output_area pre, div.nbinput.container div.input_area .highlight, div.nboutput.container div.output_area .highlight { border: none; padding: 0; margin: 0; box-shadow: none; } div.nbinput.container > div[class*=highlight], div.nboutput.container > div[class*=highlight] { margin: 0; } div.nbinput.container div.prompt *, div.nboutput.container div.prompt * { background: none; } div.nboutput.container div.output_area .highlight, div.nboutput.container div.output_area pre { background: unset; } div.nboutput.container div.output_area div.highlight { color: unset; /* override Pygments text color */ } /* avoid gaps between output lines */ div.nboutput.container div[class*=highlight] pre { line-height: normal; } /* input/output containers */ div.nbinput.container, div.nboutput.container { display: -webkit-flex; display: flex; align-items: flex-start; margin: 0; width: 100%; } @media (max-width: 540px) { div.nbinput.container, div.nboutput.container { flex-direction: column; } } /* input container */ div.nbinput.container { padding-top: 5px; } /* last container */ div.nblast.container { padding-bottom: 5px; } /* input prompt */ div.nbinput.container div.prompt pre { color: #307FC1; } /* output prompt */ div.nboutput.container div.prompt pre { color: #BF5B3D; } /* all prompts */ div.nbinput.container div.prompt, div.nboutput.container div.prompt { width: 4.5ex; padding-top: 5px; position: relative; user-select: none; } div.nbinput.container div.prompt > div, div.nboutput.container div.prompt > div { position: absolute; right: 0; margin-right: 0.3ex; } @media (max-width: 540px) { div.nbinput.container div.prompt, div.nboutput.container div.prompt { width: unset; text-align: left; padding: 0.4em; } div.nboutput.container div.prompt.empty { padding: 0; } div.nbinput.container div.prompt > div, div.nboutput.container div.prompt > div { position: unset; } } /* disable scrollbars on prompts */ div.nbinput.container div.prompt pre, div.nboutput.container div.prompt pre { overflow: hidden; } /* input/output area */ div.nbinput.container div.input_area, div.nboutput.container div.output_area { -webkit-flex: 1; flex: 1; overflow: auto; } @media (max-width: 540px) { div.nbinput.container div.input_area, div.nboutput.container div.output_area { width: 100%; } } /* input area */ div.nbinput.container div.input_area { border: 1px solid #e0e0e0; border-radius: 2px; /*background: #f5f5f5;*/ } /* override MathJax center alignment in output cells */ div.nboutput.container div[class*=MathJax] { text-align: left !important; } /* override sphinx.ext.imgmath center alignment in output cells */ div.nboutput.container div.math p { text-align: left; } /* standard error */ div.nboutput.container div.output_area.stderr { background: #fdd; } /* ANSI colors */ .ansi-black-fg { color: #3E424D; } .ansi-black-bg { background-color: #3E424D; } .ansi-black-intense-fg { color: #282C36; } .ansi-black-intense-bg { background-color: #282C36; } .ansi-red-fg { color: #E75C58; } .ansi-red-bg { background-color: #E75C58; } .ansi-red-intense-fg { color: #B22B31; } .ansi-red-intense-bg { background-color: #B22B31; } .ansi-green-fg { color: #00A250; } .ansi-green-bg { background-color: #00A250; } .ansi-green-intense-fg { color: #007427; } .ansi-green-intense-bg { background-color: #007427; } .ansi-yellow-fg { color: #DDB62B; } .ansi-yellow-bg { background-color: #DDB62B; } .ansi-yellow-intense-fg { color: #B27D12; } .ansi-yellow-intense-bg { background-color: #B27D12; } .ansi-blue-fg { color: #208FFB; } .ansi-blue-bg { background-color: #208FFB; } .ansi-blue-intense-fg { color: #0065CA; } .ansi-blue-intense-bg { background-color: #0065CA; } .ansi-magenta-fg { color: #D160C4; } .ansi-magenta-bg { background-color: #D160C4; } .ansi-magenta-intense-fg { color: #A03196; } .ansi-magenta-intense-bg { background-color: #A03196; } .ansi-cyan-fg { color: #60C6C8; } .ansi-cyan-bg { background-color: #60C6C8; } .ansi-cyan-intense-fg { color: #258F8F; } .ansi-cyan-intense-bg { background-color: #258F8F; } .ansi-white-fg { color: #C5C1B4; } .ansi-white-bg { background-color: #C5C1B4; } .ansi-white-intense-fg { color: #A1A6B2; } .ansi-white-intense-bg { background-color: #A1A6B2; } .ansi-default-inverse-fg { color: #FFFFFF; } .ansi-default-inverse-bg { background-color: #000000; } .ansi-bold { font-weight: bold; } .ansi-underline { text-decoration: underline; } div.nbinput.container div.input_area div[class*=highlight] > pre, div.nboutput.container div.output_area div[class*=highlight] > pre, div.nboutput.container div.output_area div[class*=highlight].math, div.nboutput.container div.output_area.rendered_html, div.nboutput.container div.output_area > div.output_javascript, div.nboutput.container div.output_area:not(.rendered_html) > img{ padding: 5px; margin: 0; } /* fix copybtn overflow problem in chromium (needed for 'sphinx_copybutton') */ div.nbinput.container div.input_area > div[class^='highlight'], div.nboutput.container div.output_area > div[class^='highlight']{ overflow-y: hidden; } /* hide copybtn icon on prompts (needed for 'sphinx_copybutton') */ .prompt .copybtn { display: none; } /* Some additional styling taken form the Jupyter notebook CSS */ .jp-RenderedHTMLCommon table, div.rendered_html table { border: none; border-collapse: collapse; border-spacing: 0; color: black; font-size: 12px; table-layout: fixed; } .jp-RenderedHTMLCommon thead, div.rendered_html thead { border-bottom: 1px solid black; vertical-align: bottom; } .jp-RenderedHTMLCommon tr, .jp-RenderedHTMLCommon th, .jp-RenderedHTMLCommon td, div.rendered_html tr, div.rendered_html th, div.rendered_html td { text-align: right; vertical-align: middle; padding: 0.5em 0.5em; line-height: normal; white-space: normal; max-width: none; border: none; } .jp-RenderedHTMLCommon th, div.rendered_html th { font-weight: bold; } .jp-RenderedHTMLCommon tbody tr:nth-child(odd), div.rendered_html tbody tr:nth-child(odd) { background: #f5f5f5; } .jp-RenderedHTMLCommon tbody tr:hover, div.rendered_html tbody tr:hover { background: rgba(66, 165, 245, 0.2); } </style> <div class="section" id="T5-model-inference-on-Trn1-or-Inf2"> <h1>T5 model inference on Trn1 or Inf2<a class="headerlink" href="#T5-model-inference-on-Trn1-or-Inf2" title="Permalink to this headline">#</a></h1> <div class="section" id="Introduction"> <h2>Introduction<a class="headerlink" href="#Introduction" title="Permalink to this headline">#</a></h2> <p>In this tutorial we will compile and deploy a pretrained T5 model for accelerated inference on Neuron.</p> <p>This tutorial will use the <a class="reference external" href="https://huggingface.co/t5-large">t5-large</a> model. The T5 model can be used for machine translation, document summarization, question answering, and classification tasks.</p> <p>This tutorial has the following main sections:</p> <ol class="arabic simple"> <li><p>Install dependencies</p></li> <li><p>Compile the T5 model</p></li> <li><p>Run inference with greedy decoding on Neuron</p></li> <li><p>Run infernece with beam search on Neuron</p></li> </ol> <p>This Jupyter notebook should be run on a Trn1 instance (<code class="docutils literal notranslate"><span class="pre">trn1.2xlarge</span></code> or larger.) or Inf2 instance (<code class="docutils literal notranslate"><span class="pre">inf2.xlarge</span></code> or larger.)</p> <blockquote> <div><p>Do note that flan-t5 models do not work with the code in this tutorial. We are working on fixing that.</p> </div></blockquote> </div> <div class="section" id="Install-dependencies"> <h2>Install dependencies<a class="headerlink" href="#Install-dependencies" title="Permalink to this headline">#</a></h2> <p>The code in this tutorial is written for Jupyter Notebooks. To use Jupyter Notebook on the Neuron instance, you can use this <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html">guide</a>.</p> <p>This tutorial requires the following pip packages:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">neuronx-cc</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">transformers</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">optimum-neuron</span></code></p></li> </ul> <p>Most of these packages will be installed when configuring your environment using the Trn1/Inf2 setup guide. The additional dependencies must be installed here:</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="o">!</span>pip<span class="w"> </span>install<span class="w"> </span>--upgrade<span class="w"> </span><span class="nv">transformers</span><span class="o">==</span><span class="m">4</span>.31.0<span class="w"> </span>optimum-neuron<span class="o">==</span><span class="m">0</span>.0.8 </pre></div> </div> </div> <p>🤗 Optimum Neuron is the interface between the 🤗 Transformers library and AWS Accelerators including AWS Trainium and AWS Inferentia. It provides a set of tools enabling easy model loading, training and inference on single- and multi-Accelerator settings for different downstream tasks. In this tutorial we use 🤗 HuggingFace Optimum Neuron’s generate() method instead of 🤗 <a class="reference external" href="https://huggingface.co/docs/transformers/main/en/main_classes/text_generation#transformers.GenerationMixin.generate">transformers’s generate()</a> to perform greedy decoding. Optimum Neuron takes care of padding the inputs which is necessary to infer on Neuron.</p> </div> <div class="section" id="Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript"> <h2>Compile the model into an AWS Neuron optimized TorchScript<a class="headerlink" href="#Compile-the-model-into-an-AWS-Neuron-optimized-TorchScript" title="Permalink to this headline">#</a></h2> <p>In the following section, we load the T5 model, compile the model’s encoder and decoder for Neuron using <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code>, and save the optimized encoder and decoder as <code class="docutils literal notranslate"><span class="pre">TorchScript</span></code>.</p> <p>Before we trace the model, we need to make a couple of changes.</p> <ol class="arabic simple"> <li><p>We need to write encoder and decoder wrappers - <code class="docutils literal notranslate"><span class="pre">torch_neuronx</span></code> can only trace functions with positional arguments. But the T5 encoder and decoder both use keyword arguments. So, in order to trace them, we have to write wrappers that convert keyword arguments to positional arguments</p></li> <li><p>We modify the t5 code to maximize the computation on the neuron device - Having sections of code running on cpu will reduce the performance. Moreover, we do not want to move data berween the neuron device and cpu during inference. The code we trace with <code class="docutils literal notranslate"><span class="pre">torch_neuronx</span></code> is the code that runs on the neuron device, so we refactor the t5 code to run computationally heavy operations within the wrapper.</p></li> </ol> <p>Let us start with the EncoderWrapper.</p> <p>In the huggingface t5 implementation, the encoder block takes in the input ids and returns the encoder hidden states. This hidden states are then used to initialize the KV cache in the decoder blocks during the first decoder invocation. We could trace both the encoder and the cache initialization step separately. But there is a better way, we could just compute the initial KV cache state within the encoder wrapper. This way, we remove the overhead of moving the hidden states from neuron device to cpu and back. This also allows neuron’s compiler to optimize execution across both the encoder and cache initialization.</p> <p><em>Why don’t we just initalize the cache on the first decoder run?</em></p> <p>This is harder to do on Neuron. Similar to <code class="docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code>, <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code> produces a function that has a fixed control flow, i.e.&nbsp;there are no conditional executions. So we cannot choose to conditionally initialize the cache in the first decoder iteration. Instead, we can compute the initial cache state outside the generation flow and pass the cache to it.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">from</span> <span class="nn">transformers.models.t5.modeling_t5</span> <span class="kn">import</span> <span class="n">T5Stack</span><span class="p">,</span> <span class="n">T5LayerCrossAttention</span> <span class="k">class</span> <span class="nc">EncoderWrapper</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="w"> </span><span class="sd">'''</span> <span class="sd"> We will trace an instance of the EncoderWrapper.</span> <span class="sd"> This wrapper just converts positional args to kwargs.</span> <span class="sd"> '''</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">encoder</span><span class="p">,</span> <span class="n">decoder</span><span class="p">,</span> <span class="n">model_config</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="n">device</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">,</span> <span class="n">tp_degree</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoder</span> <span class="o">=</span> <span class="n">encoder</span> <span class="bp">self</span><span class="o">.</span><span class="n">decoder</span> <span class="o">=</span> <span class="n">decoder</span> <span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span> <span class="o">=</span> <span class="n">batch_size</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_length</span> <span class="o">=</span> <span class="n">max_length</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_config</span> <span class="o">=</span> <span class="n">model_config</span> <span class="bp">self</span><span class="o">.</span><span class="n">device</span> <span class="o">=</span> <span class="n">device</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_beams</span> <span class="o">=</span> <span class="n">num_beams</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_attention_heads_per_partition</span> <span class="o">=</span> <span class="n">model_config</span><span class="o">.</span><span class="n">num_heads</span> <span class="bp">self</span><span class="o">.</span><span class="n">tp_degree</span> <span class="o">=</span> <span class="n">tp_degree</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">input_ids</span><span class="p">,</span> <span class="n">attention_mask</span><span class="p">):</span> <span class="w"> </span><span class="sd">'''</span> <span class="sd"> This is the core functionality we want to trace.</span> <span class="sd"> '''</span> <span class="n">encoder_output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoder</span><span class="p">(</span><span class="n">input_ids</span><span class="o">=</span><span class="n">input_ids</span><span class="p">,</span> <span class="n">attention_mask</span><span class="o">=</span><span class="n">attention_mask</span><span class="p">,</span> <span class="n">output_attentions</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">output_hidden_states</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="n">last_hidden_state</span> <span class="o">=</span> <span class="n">encoder_output</span><span class="p">[</span><span class="s2">"last_hidden_state"</span><span class="p">]</span> <span class="n">encoder_hidden_states</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">concat</span><span class="p">([</span><span class="n">tensor</span><span class="o">.</span><span class="n">unsqueeze</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span><span class="o">.</span><span class="n">repeat</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">num_beams</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">tensor</span> <span class="ow">in</span> <span class="n">last_hidden_state</span><span class="p">])</span> <span class="n">decoder_blocks</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">decoder</span><span class="o">.</span><span class="n">block</span> <span class="n">present_key_value_states_sa</span> <span class="o">=</span> <span class="p">[]</span> <span class="n">present_key_value_states_ca</span> <span class="o">=</span> <span class="p">[]</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">block</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">decoder_blocks</span><span class="p">):</span> <span class="c1"># Cross attention has to be initialized with the encoder hidden state</span> <span class="n">cross_attention</span><span class="p">:</span> <span class="n">T5LayerCrossAttention</span> <span class="o">=</span> <span class="n">block</span><span class="o">.</span><span class="n">layer</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="n">attention</span> <span class="o">=</span> <span class="n">cross_attention</span><span class="o">.</span><span class="n">EncDecAttention</span> <span class="k">def</span> <span class="nf">shape</span><span class="p">(</span><span class="n">states</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""projection"""</span> <span class="k">return</span> <span class="n">states</span><span class="o">.</span><span class="n">view</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_attention_heads_per_partition</span><span class="p">,</span> <span class="n">attention</span><span class="o">.</span><span class="n">key_value_proj_dim</span><span class="p">)</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="n">key_states</span> <span class="o">=</span> <span class="n">shape</span><span class="p">(</span><span class="n">attention</span><span class="o">.</span><span class="n">k</span><span class="p">(</span><span class="n">encoder_hidden_states</span><span class="p">))</span> <span class="n">value_states</span> <span class="o">=</span> <span class="n">shape</span><span class="p">(</span><span class="n">attention</span><span class="o">.</span><span class="n">v</span><span class="p">(</span><span class="n">encoder_hidden_states</span><span class="p">))</span> <span class="c1"># cross_attn_kv_state</span> <span class="n">present_key_value_states_ca</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key_states</span><span class="p">)</span> <span class="n">present_key_value_states_ca</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value_states</span><span class="p">)</span> <span class="c1"># Self attention kv states are initialized to zeros. This is done to keep the size of the kv cache tensor constant.</span> <span class="c1"># The kv cache will be an input to the decoder trace. Any traced function will have a fixed control flow. What this means</span> <span class="c1"># is that the trace performs the exact same computations on inputs of the same shape in each invocation. So the attention</span> <span class="c1"># kv cache is padded here to keep a fixed shape.</span> <span class="n">present_key_value_states_sa</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span><span class="p">,</span> <span class="c1"># key states</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_config</span><span class="o">.</span><span class="n">num_heads</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_length</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_config</span><span class="o">.</span><span class="n">d_kv</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">device</span><span class="p">))</span> <span class="n">present_key_value_states_sa</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span><span class="p">,</span> <span class="c1"># value states</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_config</span><span class="o">.</span><span class="n">num_heads</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_length</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_config</span><span class="o">.</span><span class="n">d_kv</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">device</span><span class="p">))</span> <span class="k">return</span> <span class="n">present_key_value_states_sa</span> <span class="o">+</span> <span class="n">present_key_value_states_ca</span> <br></pre></div> </div> </div> <p>In the decoder wrapper, in addition to converting keyword arguments to positional arguments we add support for attention caching. Generating text from the encoder decoder models is an autoregressive process. For each invocation, we have to compute the key and value states of the attention heads repeatedly. To improve the performance, we cache the key and value states. This cache is what HuggingFace transformers code refers to as <code class="docutils literal notranslate"><span class="pre">past_key_values</span></code>.</p> <p>In HuggingFace transformers, the <code class="docutils literal notranslate"><span class="pre">past_key_values</span></code> are updated outside the decoder. This works for training and evaluation but for inference we want to perform them within a single trace. This way, we can optimize across both the decoder execution and cache update. So, we move the cache update within the decoder wrapper.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[3]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">DecoderWrapper</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">decoder</span><span class="p">:</span> <span class="n">T5Stack</span><span class="p">,</span> <span class="n">lm_head</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">,</span> <span class="n">model_config</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">max_length</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">device</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">tp_degree</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">decoder</span> <span class="o">=</span> <span class="n">decoder</span> <span class="bp">self</span><span class="o">.</span><span class="n">lm_head</span> <span class="o">=</span> <span class="n">lm_head</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_dim</span><span class="o">=</span><span class="n">model_config</span><span class="o">.</span><span class="n">d_model</span> <span class="bp">self</span><span class="o">.</span><span class="n">device</span> <span class="o">=</span> <span class="n">device</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_beams</span> <span class="o">=</span> <span class="n">num_beams</span> <span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span> <span class="o">=</span> <span class="mi">1</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">model_config</span> <span class="n">num_heads</span><span class="o">=</span><span class="n">model_config</span><span class="o">.</span><span class="n">num_heads</span> <span class="n">num_decoder_layers</span><span class="o">=</span><span class="n">model_config</span><span class="o">.</span><span class="n">num_decoder_layers</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_attention_heads_per_partition</span> <span class="o">=</span> <span class="n">num_heads</span> <span class="c1"># (num_beams, n_heads, seq_length, dim_per_head)</span> <span class="k">if</span> <span class="n">device</span> <span class="o">==</span> <span class="s2">"cpu"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_sa</span> <span class="o">=</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">num_beams</span><span class="p">,</span><span class="n">num_heads</span><span class="p">,</span><span class="n">max_length</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span><span class="n">model_config</span><span class="o">.</span><span class="n">d_kv</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_decoder_layers</span> <span class="o">*</span> <span class="mi">2</span><span class="p">)]</span> <span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_ca</span> <span class="o">=</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">num_beams</span><span class="p">,</span><span class="n">num_heads</span><span class="p">,</span><span class="n">max_length</span><span class="p">,</span><span class="n">model_config</span><span class="o">.</span><span class="n">d_kv</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_decoder_layers</span> <span class="o">*</span> <span class="mi">2</span><span class="p">)]</span> <span class="k">elif</span> <span class="n">device</span> <span class="o">==</span> <span class="s2">"xla"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_sa</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">ParameterList</span><span class="p">([</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Parameter</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">num_beams</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">num_attention_heads_per_partition</span><span class="p">,</span><span class="n">max_length</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span><span class="n">model_config</span><span class="o">.</span><span class="n">d_kv</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float32</span><span class="p">),</span> <span class="n">requires_grad</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_decoder_layers</span> <span class="o">*</span> <span class="mi">2</span><span class="p">)])</span> <span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_ca</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">ParameterList</span><span class="p">([</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Parameter</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">num_beams</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">num_attention_heads_per_partition</span><span class="p">,</span><span class="n">max_length</span><span class="p">,</span><span class="n">model_config</span><span class="o">.</span><span class="n">d_kv</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float32</span><span class="p">),</span> <span class="n">requires_grad</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_decoder_layers</span> <span class="o">*</span> <span class="mi">2</span><span class="p">)])</span> <span class="k">def</span> <span class="nf">update_past</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">past_key_values</span><span class="p">):</span> <span class="n">new_past_sa</span> <span class="o">=</span> <span class="p">[]</span> <span class="n">new_past_ca</span> <span class="o">=</span> <span class="p">[]</span> <span class="k">for</span> <span class="n">past_layer</span> <span class="ow">in</span> <span class="n">past_key_values</span><span class="p">:</span> <span class="n">new_past_layer</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">past_layer</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">new_past_layer</span><span class="p">[:</span><span class="mi">2</span><span class="p">])):</span> <span class="n">new_past_layer</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">past_layer</span><span class="p">[</span><span class="n">i</span><span class="p">][:,</span> <span class="p">:,</span> <span class="mi">1</span><span class="p">:]</span> <span class="n">new_past_sa</span> <span class="o">+=</span> <span class="p">[</span><span class="n">new_past_layer</span><span class="p">[:</span><span class="mi">2</span><span class="p">],]</span> <span class="n">new_past_ca</span> <span class="o">+=</span> <span class="p">[</span><span class="n">new_past_layer</span><span class="p">[</span><span class="mi">2</span><span class="p">:],]</span> <span class="k">return</span> <span class="n">new_past_sa</span><span class="p">,</span> <span class="n">new_past_ca</span> <span class="k">def</span> <span class="nf">reorder_cache</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">past_key_values</span><span class="p">,</span> <span class="n">beam_idx</span><span class="p">):</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">past_key_values</span><span class="p">)):</span> <span class="n">gather_index</span> <span class="o">=</span> <span class="n">beam_idx</span><span class="o">.</span><span class="n">view</span><span class="p">([</span><span class="n">beam_idx</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">])</span><span class="o">.</span><span class="n">expand_as</span><span class="p">(</span><span class="n">past_key_values</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="n">past_key_values</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">gather</span><span class="p">(</span><span class="n">past_key_values</span><span class="p">[</span><span class="n">i</span><span class="p">],</span> <span class="n">dim</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="n">gather_index</span><span class="p">)</span> <span class="k">return</span> <span class="n">past_key_values</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">input_ids</span><span class="p">,</span> <span class="n">decoder_attention_mask</span><span class="p">,</span> <span class="n">encoder_hidden_states</span><span class="p">,</span> <span class="n">encoder_attention_mask</span><span class="p">,</span> <span class="n">beam_idx</span><span class="p">,</span> <span class="n">beam_scores</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_beams</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span> <span class="c1"># We reorder the cache based on the beams selected in each iteration. Required step for beam search.</span> <span class="n">past_key_values_sa</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">reorder_cache</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_sa</span><span class="p">,</span> <span class="n">beam_idx</span><span class="p">)</span> <span class="n">past_key_values_ca</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">reorder_cache</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_ca</span><span class="p">,</span> <span class="n">beam_idx</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="c1"># We do not need to reorder for greedy sampling</span> <span class="n">past_key_values_sa</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_sa</span> <span class="n">past_key_values_ca</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_ca</span> <span class="c1"># The cache is stored in a flatten form. We order the cache per layer before passing it to the decoder.</span> <span class="c1"># Each layer has 4 tensors, so we group by 4.</span> <span class="n">past_key_values</span> <span class="o">=</span> <span class="p">[[</span><span class="o">*</span><span class="n">past_key_values_sa</span><span class="p">[</span><span class="n">i</span><span class="o">*</span><span class="mi">2</span><span class="p">:</span><span class="n">i</span><span class="o">*</span><span class="mi">2</span><span class="o">+</span><span class="mi">2</span><span class="p">],</span> <span class="o">*</span><span class="n">past_key_values_ca</span><span class="p">[</span><span class="n">i</span><span class="o">*</span><span class="mi">2</span><span class="p">:</span><span class="n">i</span><span class="o">*</span><span class="mi">2</span><span class="o">+</span><span class="mi">2</span><span class="p">]]</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">past_key_values_ca</span><span class="p">)</span><span class="o">/</span><span class="mi">2</span><span class="p">))]</span> <span class="n">decoder_output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">decoder</span><span class="p">(</span> <span class="n">input_ids</span><span class="o">=</span><span class="n">input_ids</span><span class="p">,</span> <span class="n">attention_mask</span><span class="o">=</span><span class="n">decoder_attention_mask</span><span class="p">,</span> <span class="n">past_key_values</span><span class="o">=</span><span class="n">past_key_values</span><span class="p">,</span> <span class="n">encoder_hidden_states</span><span class="o">=</span><span class="n">encoder_hidden_states</span><span class="p">,</span> <span class="n">encoder_attention_mask</span><span class="o">=</span><span class="n">encoder_attention_mask</span><span class="p">,</span> <span class="n">use_cache</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">output_attentions</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">output_hidden_states</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="n">last_hidden_state</span> <span class="o">=</span> <span class="n">decoder_output</span><span class="p">[</span><span class="s1">'last_hidden_state'</span><span class="p">]</span> <span class="n">past_key_values</span> <span class="o">=</span> <span class="n">decoder_output</span><span class="p">[</span><span class="s1">'past_key_values'</span><span class="p">]</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">tie_word_embeddings</span><span class="p">:</span> <span class="c1"># Rescale output before projecting on vocab</span> <span class="c1"># See https://github.com/tensorflow/mesh/blob/fa19d69eafc9a482aff0b59ddd96b025c0cb207d/mesh_tensorflow/transformer/transformer.py#L586</span> <span class="n">last_hidden_state</span> <span class="o">=</span> <span class="n">last_hidden_state</span> <span class="o">*</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model_dim</span><span class="o">**-</span><span class="mf">0.5</span><span class="p">)</span> <span class="n">lm_logits</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lm_head</span><span class="p">(</span><span class="n">last_hidden_state</span><span class="p">)</span> <span class="n">past_key_values_sa</span><span class="p">,</span> <span class="n">past_key_values_ca</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">update_past</span><span class="p">(</span><span class="n">past_key_values</span><span class="p">)</span> <span class="c1"># We flatten the cache to a single array. This is required for the input output aliasing to work</span> <span class="n">past_key_values_sa</span> <span class="o">=</span> <span class="p">[</span><span class="n">vec</span> <span class="k">for</span> <span class="n">kv_per_layer</span> <span class="ow">in</span> <span class="n">past_key_values_sa</span> <span class="k">for</span> <span class="n">vec</span> <span class="ow">in</span> <span class="n">kv_per_layer</span><span class="p">]</span> <span class="n">past_key_values_ca</span> <span class="o">=</span> <span class="p">[</span><span class="n">vec</span> <span class="k">for</span> <span class="n">kv_per_layer</span> <span class="ow">in</span> <span class="n">past_key_values_ca</span> <span class="k">for</span> <span class="n">vec</span> <span class="ow">in</span> <span class="n">kv_per_layer</span><span class="p">]</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">device</span> <span class="o">==</span> <span class="s2">"cpu"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_sa</span> <span class="o">=</span> <span class="n">past_key_values_sa</span> <span class="bp">self</span><span class="o">.</span><span class="n">past_key_values_ca</span> <span class="o">=</span> <span class="n">past_key_values_ca</span> <span class="c1"># We calculate topk inside the wrapper</span> <span class="n">next_token_logits</span> <span class="o">=</span> <span class="n">lm_logits</span><span class="p">[:,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="p">:]</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_beams</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span> <span class="c1"># This section of beam search is run outside the decoder in the huggingface t5 implementation.</span> <span class="c1"># To maximize the computation within the neuron device, we move this within the wrapper</span> <span class="n">logit_max</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">next_token_logits</span><span class="p">,</span> <span class="n">dim</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">keepdim</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">logsumexp</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="n">next_token_logits</span> <span class="o">-</span> <span class="n">logit_max</span><span class="p">)</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">dim</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">keepdim</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span> <span class="n">next_token_scores</span> <span class="o">=</span> <span class="n">next_token_logits</span> <span class="o">-</span> <span class="n">logit_max</span> <span class="o">-</span> <span class="n">logsumexp</span> <span class="n">next_token_scores</span> <span class="o">=</span> <span class="n">next_token_scores</span> <span class="o">+</span> <span class="n">beam_scores</span><span class="p">[:,</span> <span class="kc">None</span><span class="p">]</span><span class="o">.</span><span class="n">expand_as</span><span class="p">(</span><span class="n">next_token_scores</span><span class="p">)</span> <span class="c1"># reshape for beam search</span> <span class="n">vocab_size</span> <span class="o">=</span> <span class="n">next_token_scores</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="n">next_token_scores</span> <span class="o">=</span> <span class="n">next_token_scores</span><span class="o">.</span><span class="n">view</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">batch_size</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_beams</span> <span class="o">*</span> <span class="n">vocab_size</span><span class="p">)</span> <span class="n">next_token_scores</span> <span class="o">=</span> <span class="n">next_token_scores</span> <span class="o">*</span> <span class="mi">1</span> <span class="c1"># Sample 2 next tokens for each beam (so we have some spare tokens and match output of beam search)</span> <span class="n">next_token_scores</span><span class="p">,</span> <span class="n">next_tokens</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">topk</span><span class="p">(</span> <span class="n">next_token_scores</span><span class="p">,</span> <span class="mi">2</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">largest</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="nb">sorted</span><span class="o">=</span><span class="kc">True</span> <span class="p">)</span> <span class="n">next_indices</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">div</span><span class="p">(</span><span class="n">next_tokens</span><span class="p">,</span> <span class="n">vocab_size</span><span class="p">,</span> <span class="n">rounding_mode</span><span class="o">=</span><span class="s2">"floor"</span><span class="p">)</span> <span class="n">next_tokens</span> <span class="o">=</span> <span class="n">next_tokens</span> <span class="o">%</span> <span class="n">vocab_size</span> <span class="k">return</span> <span class="p">[</span><span class="n">next_token_scores</span><span class="p">,</span> <span class="n">next_tokens</span><span class="p">,</span> <span class="n">next_indices</span><span class="p">]</span> <span class="o">+</span> <span class="n">past_key_values_sa</span> <span class="o">+</span> <span class="n">past_key_values_ca</span> <span class="k">else</span><span class="p">:</span> <span class="c1"># Greedy</span> <span class="n">next_tokens</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">argmax</span><span class="p">(</span><span class="n">next_token_logits</span><span class="p">,</span> <span class="n">dim</span><span class="o">=-</span><span class="mi">1</span><span class="p">)</span> <span class="k">return</span> <span class="p">[</span><span class="n">next_tokens</span><span class="p">]</span> <span class="o">+</span> <span class="n">past_key_values_sa</span> <span class="o">+</span> <span class="n">past_key_values_ca</span> <br><br></pre></div> </div> </div> <p>Now let’s create a T5 model wrapper to make it compatible with our traced encoder and decoder.</p> <p>There are two reasons for having this wrapper,</p> <ol class="arabic simple"> <li><p>The encoder and decoder traces can only be invoked with positional arguments. But the HuggingFace transformers code is written with keyword arguments. So we override the functions that invoke encoder and decoder to call with positional arguments.</p></li> <li><p>The generate() function in the NeuronGenerationMixin performs cache update within the CPU. As we are handling the cache within the DecoderWrapper, we disable the cache update on CPU.</p></li> <li><p>The topK computation to determine the next tokens for beam search was moved into the decoder wrapper. So, we need to override the huggingface’s beam search implementation to accept the next tokens and the beam scores from the decoder.</p></li> </ol> <p>Let’s also override the <code class="docutils literal notranslate"><span class="pre">generate()</span></code> function so that it will intialize the cache using the cache initalizer before starting the greedy decoding.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[4]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">T5Tokenizer</span><span class="p">,</span> <span class="n">T5ForConditionalGeneration</span> <span class="kn">from</span> <span class="nn">transformers.modeling_outputs</span> <span class="kn">import</span> <span class="n">BaseModelOutput</span><span class="p">,</span> <span class="n">Seq2SeqLMOutput</span> <span class="kn">from</span> <span class="nn">transformers.models.t5.modeling_t5</span> <span class="kn">import</span> <span class="n">T5Stack</span><span class="p">,</span> <span class="n">T5LayerCrossAttention</span> <span class="kn">from</span> <span class="nn">transformers.generation.utils</span> <span class="kn">import</span> <span class="n">ModelOutput</span> <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Union</span> <span class="kn">from</span> <span class="nn">transformers.generation.beam_search</span> <span class="kn">import</span> <span class="n">BeamScorer</span><span class="p">,</span> <span class="n">BeamSearchScorer</span> <span class="kn">from</span> <span class="nn">optimum.neuron.generation</span> <span class="kn">import</span> <span class="n">NeuronGenerationMixin</span> <span class="kn">from</span> <span class="nn">transformers.generation.logits_process</span> <span class="kn">import</span> <span class="p">(</span> <span class="n">LogitsProcessorList</span><span class="p">,</span> <span class="p">)</span> <span class="kn">from</span> <span class="nn">transformers.generation.stopping_criteria</span> <span class="kn">import</span> <span class="p">(</span> <span class="n">MaxLengthCriteria</span><span class="p">,</span> <span class="n">MaxTimeCriteria</span><span class="p">,</span> <span class="n">StoppingCriteriaList</span><span class="p">,</span> <span class="n">validate_stopping_criteria</span><span class="p">,</span> <span class="p">)</span> <span class="kn">from</span> <span class="nn">transformers.generation.utils</span> <span class="kn">import</span> <span class="p">(</span> <span class="n">BeamSearchOutput</span><span class="p">,</span> <span class="n">GreedySearchOutput</span><span class="p">,</span> <span class="p">)</span> <span class="k">class</span> <span class="nc">T5Wrapper</span><span class="p">(</span><span class="n">T5ForConditionalGeneration</span><span class="p">,</span> <span class="n">NeuronGenerationMixin</span><span class="p">):</span> <span class="k">def</span> <span class="nf">_prepare_encoder_decoder_kwargs_for_generation</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">inputs_tensor</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">model_kwargs</span><span class="p">,</span> <span class="n">model_input_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span> <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span> <span class="n">encoder</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_encoder</span><span class="p">()</span> <span class="n">model_kwargs</span><span class="p">[</span><span class="s2">"encoder_outputs"</span><span class="p">]:</span> <span class="n">ModelOutput</span> <span class="o">=</span> <span class="n">encoder</span><span class="p">(</span><span class="n">inputs_tensor</span><span class="p">,</span> <span class="n">model_kwargs</span><span class="p">[</span><span class="s2">"attention_mask"</span><span class="p">])</span> <span class="k">return</span> <span class="n">model_kwargs</span> <span class="c1"># Override to cut the input_ids to just last token</span> <span class="k">def</span> <span class="nf">prepare_inputs_for_generation</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">input_ids</span><span class="p">,</span> <span class="n">past_key_values</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">attention_mask</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">head_mask</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">decoder_head_mask</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">decoder_attention_mask</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">cross_attn_head_mask</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">use_cache</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">encoder_outputs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> <span class="p">):</span> <span class="c1"># cut decoder_input_ids as past is cached</span> <span class="n">input_ids</span> <span class="o">=</span> <span class="n">input_ids</span><span class="p">[:,</span> <span class="o">-</span><span class="mi">1</span><span class="p">:]</span> <span class="k">return</span> <span class="p">{</span> <span class="s2">"decoder_input_ids"</span><span class="p">:</span> <span class="n">input_ids</span><span class="p">,</span> <span class="s2">"past_key_values"</span><span class="p">:</span> <span class="n">past_key_values</span><span class="p">,</span> <span class="s2">"encoder_outputs"</span><span class="p">:</span> <span class="n">encoder_outputs</span><span class="p">,</span> <span class="s2">"attention_mask"</span><span class="p">:</span> <span class="n">attention_mask</span><span class="p">,</span> <span class="s2">"head_mask"</span><span class="p">:</span> <span class="n">head_mask</span><span class="p">,</span> <span class="s2">"decoder_head_mask"</span><span class="p">:</span> <span class="n">decoder_head_mask</span><span class="p">,</span> <span class="s2">"decoder_attention_mask"</span><span class="p">:</span> <span class="n">decoder_attention_mask</span><span class="p">,</span> <span class="s2">"cross_attn_head_mask"</span><span class="p">:</span> <span class="n">cross_attn_head_mask</span><span class="p">,</span> <span class="s2">"use_cache"</span><span class="p">:</span> <span class="n">use_cache</span><span class="p">,</span> <span class="p">}</span> <span class="w"> </span><span class="sd">'''</span> <span class="sd"> We update the cache in the decoder trace, so lets override the _update_model_kwargs_for_xla_generation in NeuronGenerationMixin</span> <span class="sd"> '''</span> <span class="k">def</span> <span class="nf">_update_model_kwargs_for_xla_generation</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">model_kwargs</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span> <span class="n">batch_size</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">is_encoder_decoder</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">standardize_cache_format</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">max_length</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">seq_length</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">use_cache</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span> <span class="k">def</span> <span class="nf">_update_attention</span><span class="p">(</span><span class="n">model_kwargs</span><span class="p">,</span> <span class="n">is_encoder_decoder</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""Updates the appropriate attention mask -- encoder-decoder models use `decoder_attention_mask`"""</span> <span class="n">attention_mask_name</span> <span class="o">=</span> <span class="s2">"decoder_attention_mask"</span> <span class="k">if</span> <span class="n">is_encoder_decoder</span> <span class="k">else</span> <span class="s2">"attention_mask"</span> <span class="n">attention_mask</span> <span class="o">=</span> <span class="n">model_kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">attention_mask_name</span><span class="p">)</span> <span class="n">attention_mask_update_slice</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span> <span class="p">(</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">attention_mask</span><span class="o">.</span><span class="n">dtype</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="n">attention_mask</span><span class="o">.</span><span class="n">device</span> <span class="p">)</span> <span class="n">attention_mask</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">([</span><span class="n">attention_mask</span><span class="p">[:,</span> <span class="mi">1</span><span class="p">:],</span> <span class="n">attention_mask_update_slice</span><span class="p">],</span> <span class="n">dim</span><span class="o">=-</span><span class="mi">1</span><span class="p">)</span> <span class="n">mask</span> <span class="o">=</span> <span class="p">{</span><span class="n">attention_mask_name</span><span class="p">:</span> <span class="n">attention_mask</span><span class="p">}</span> <span class="k">return</span> <span class="n">mask</span> <span class="n">mask</span> <span class="o">=</span> <span class="n">_update_attention</span><span class="p">(</span><span class="n">model_kwargs</span><span class="p">,</span> <span class="n">is_encoder_decoder</span><span class="p">)</span> <span class="c1"># sets the updated variables (mask and past_key_values)</span> <span class="n">model_kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">mask</span><span class="p">)</span> <span class="c1"># Set a mock cache tensor</span> <span class="n">model_kwargs</span><span class="p">[</span><span class="s2">"past_key_values"</span><span class="p">]</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([])</span> <span class="k">return</span> <span class="n">model_kwargs</span> <span class="k">def</span> <span class="nf">_reorder_cache</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">past_key_values</span><span class="p">,</span> <span class="n">beam_idx</span><span class="p">):</span> <span class="w"> </span><span class="sd">'''</span> <span class="sd"> This is needed for beam search and not greedy sampling</span> <span class="sd"> We reorder the cache within the trace so we can skip it in modelling_t5.py. So we override the _reorder_cache</span> <span class="sd"> '''</span> <span class="bp">self</span><span class="o">.</span><span class="n">beam_idx</span> <span class="o">=</span> <span class="n">beam_idx</span> <span class="k">return</span> <span class="n">past_key_values</span> <span class="k">def</span> <span class="nf">generate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tokenizer</span><span class="p">:</span> <span class="n">T5Tokenizer</span><span class="p">,</span> <span class="n">prompt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">max_length</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">num_return_sequences</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">device</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span> <span class="n">batch_encoding</span> <span class="o">=</span> <span class="n">tokenizer</span><span class="p">(</span><span class="n">prompt</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">,</span> <span class="n">truncation</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">padding</span><span class="o">=</span><span class="s1">'max_length'</span><span class="p">,</span> <span class="n">return_tensors</span><span class="o">=</span><span class="s2">"pt"</span><span class="p">)</span> <span class="n">past_key_values</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoder</span><span class="p">(</span><span class="n">batch_encoding</span><span class="p">[</span><span class="s1">'input_ids'</span><span class="p">],</span><span class="n">batch_encoding</span><span class="p">[</span><span class="s1">'attention_mask'</span><span class="p">])</span> <span class="n">decoder_attention_mask</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">([</span><span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span> <span class="n">max_length</span><span class="o">-</span><span class="mi">1</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">int32</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">int32</span><span class="p">)],</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># copy the new cache state to the decoder</span> <span class="k">if</span> <span class="n">device</span> <span class="o">==</span> <span class="s2">"xla"</span><span class="p">:</span> <span class="k">for</span> <span class="n">state</span><span class="p">,</span> <span class="n">tensor</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">decoder</span><span class="o">.</span><span class="n">parameters</span><span class="p">(),</span> <span class="n">past_key_values</span><span class="p">):</span> <span class="n">state</span><span class="o">.</span><span class="n">copy_</span><span class="p">(</span><span class="n">tensor</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="c1"># First half of the cache is self attention and the rest is cross attention</span> <span class="bp">self</span><span class="o">.</span><span class="n">decoder</span><span class="o">.</span><span class="n">past_key_values_sa</span> <span class="o">=</span> <span class="n">past_key_values</span><span class="p">[:</span><span class="nb">len</span><span class="p">(</span><span class="n">past_key_values</span><span class="p">)</span><span class="o">//</span><span class="mi">2</span><span class="p">]</span> <span class="bp">self</span><span class="o">.</span><span class="n">decoder</span><span class="o">.</span><span class="n">past_key_values_ca</span> <span class="o">=</span> <span class="n">past_key_values</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">past_key_values</span><span class="p">)</span><span class="o">//</span><span class="mi">2</span><span class="p">:]</span> <span class="n">output</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="o">**</span><span class="n">batch_encoding</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">,</span> <span class="n">num_beams</span><span class="o">=</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">num_return_sequences</span><span class="o">=</span><span class="n">num_return_sequences</span><span class="p">,</span> <span class="n">do_sample</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">use_cache</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">decoder_attention_mask</span><span class="o">=</span><span class="n">decoder_attention_mask</span><span class="p">,</span> <span class="n">encoder_outputs</span><span class="o">=</span><span class="p">{</span><span class="s2">"last_hidden_state"</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span><span class="mi">128</span><span class="p">,</span><span class="mi">1</span><span class="p">))})</span> <span class="c1"># Pass fake encoder_outputs so the transfomers code will not invoke the encoder</span> <span class="k">return</span> <span class="n">output</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">attention_mask</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">FloatTensor</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">decoder_input_ids</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">LongTensor</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">decoder_attention_mask</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">BoolTensor</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">encoder_outputs</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">beam_scores</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span> <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">FloatTensor</span><span class="p">],</span> <span class="n">Seq2SeqLMOutput</span><span class="p">]:</span> <span class="n">hidden_states</span> <span class="o">=</span> <span class="n">encoder_outputs</span><span class="p">[</span><span class="s2">"last_hidden_state"</span><span class="p">]</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'beam_idx'</span><span class="p">):</span> <span class="c1"># Infering the number of beams from the attention mask</span> <span class="n">num_beams</span> <span class="o">=</span> <span class="n">attention_mask</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="bp">self</span><span class="o">.</span><span class="n">beam_idx</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">int64</span><span class="p">)</span> <span class="n">decoder_outputs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">decoder</span><span class="p">(</span> <span class="n">decoder_input_ids</span><span class="p">,</span> <span class="n">decoder_attention_mask</span><span class="p">,</span> <span class="n">hidden_states</span><span class="p">,</span> <span class="n">attention_mask</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">beam_idx</span><span class="p">,</span> <span class="n">beam_scores</span> <span class="p">)</span> <span class="c1"># lm_logits = decoder_outputs[0]</span> <span class="n">next_token_scores</span> <span class="o">=</span> <span class="n">decoder_outputs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="n">next_tokens</span> <span class="o">=</span> <span class="n">decoder_outputs</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="n">next_indices</span> <span class="o">=</span> <span class="n">decoder_outputs</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="k">return</span> <span class="n">next_token_scores</span><span class="p">,</span> <span class="n">next_tokens</span><span class="p">,</span> <span class="n">next_indices</span> <span class="k">def</span> <span class="nf">beam_search</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">input_ids</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">LongTensor</span><span class="p">,</span> <span class="n">beam_scorer</span><span class="p">:</span> <span class="n">BeamScorer</span><span class="p">,</span> <span class="n">logits_processor</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">LogitsProcessorList</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">stopping_criteria</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">StoppingCriteriaList</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">max_length</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">pad_token_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">eos_token_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="nb">int</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">output_attentions</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">output_hidden_states</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">output_scores</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">return_dict_in_generate</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">synced_gpus</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">seq_length</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">model_kwargs</span><span class="p">,</span> <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="n">BeamSearchOutput</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">LongTensor</span><span class="p">]:</span> <span class="n">logits_processor</span> <span class="o">=</span> <span class="n">logits_processor</span> <span class="k">if</span> <span class="n">logits_processor</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">LogitsProcessorList</span><span class="p">()</span> <span class="n">stopping_criteria</span> <span class="o">=</span> <span class="n">stopping_criteria</span> <span class="k">if</span> <span class="n">stopping_criteria</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">StoppingCriteriaList</span><span class="p">()</span> <span class="n">pad_token_id</span> <span class="o">=</span> <span class="n">pad_token_id</span> <span class="k">if</span> <span class="n">pad_token_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">pad_token_id</span> <span class="n">eos_token_id</span> <span class="o">=</span> <span class="n">eos_token_id</span> <span class="k">if</span> <span class="n">eos_token_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">eos_token_id</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">eos_token_id</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span> <span class="n">eos_token_id</span> <span class="o">=</span> <span class="p">[</span><span class="n">eos_token_id</span><span class="p">]</span> <span class="n">output_scores</span> <span class="o">=</span> <span class="n">output_scores</span> <span class="k">if</span> <span class="n">output_scores</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">output_scores</span> <span class="n">output_attentions</span> <span class="o">=</span> <span class="p">(</span> <span class="n">output_attentions</span> <span class="k">if</span> <span class="n">output_attentions</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">output_attentions</span> <span class="p">)</span> <span class="n">output_hidden_states</span> <span class="o">=</span> <span class="p">(</span> <span class="n">output_hidden_states</span> <span class="k">if</span> <span class="n">output_hidden_states</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">output_hidden_states</span> <span class="p">)</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">beam_scorer</span><span class="o">.</span><span class="n">_beam_hyps</span><span class="p">)</span> <span class="n">num_beams</span> <span class="o">=</span> <span class="n">beam_scorer</span><span class="o">.</span><span class="n">num_beams</span> <span class="n">batch_beam_size</span><span class="p">,</span> <span class="n">cur_len</span> <span class="o">=</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">shape</span> <span class="c1"># Overwrite cur_len</span> <span class="n">cur_len</span> <span class="o">=</span> <span class="n">seq_length</span> <span class="k">if</span> <span class="n">num_beams</span> <span class="o">*</span> <span class="n">batch_size</span> <span class="o">!=</span> <span class="n">batch_beam_size</span><span class="p">:</span> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> <span class="sa">f</span><span class="s2">"Batch dimension of `input_ids` should be </span><span class="si">{</span><span class="n">num_beams</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">batch_size</span><span class="si">}</span><span class="s2">, but is </span><span class="si">{</span><span class="n">batch_beam_size</span><span class="si">}</span><span class="s2">."</span> <span class="p">)</span> <span class="c1"># init attention / hidden states / scores tuples</span> <span class="n">scores</span> <span class="o">=</span> <span class="p">()</span> <span class="k">if</span> <span class="p">(</span><span class="n">return_dict_in_generate</span> <span class="ow">and</span> <span class="n">output_scores</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span> <span class="n">beam_indices</span> <span class="o">=</span> <span class="p">(</span> <span class="nb">tuple</span><span class="p">(()</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">batch_beam_size</span><span class="p">))</span> <span class="k">if</span> <span class="p">(</span><span class="n">return_dict_in_generate</span> <span class="ow">and</span> <span class="n">output_scores</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span> <span class="p">)</span> <span class="c1"># initialise score of first beam with 0 and the rest with -1e9. This makes sure that only tokens</span> <span class="c1"># of the first beam are considered to avoid sampling the exact same tokens across all beams.</span> <span class="c1"># beam_scores = torch.zeros((batch_size, num_beams), dtype=torch.float, device=input_ids.device)</span> <span class="n">beam_scores_device</span> <span class="o">=</span> <span class="s2">"cpu"</span> <span class="n">beam_scores</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="n">beam_scores_device</span><span class="p">)</span> <span class="n">beam_scores</span><span class="p">[:,</span> <span class="mi">1</span><span class="p">:]</span> <span class="o">=</span> <span class="o">-</span><span class="mf">1e9</span> <span class="n">beam_scores</span> <span class="o">=</span> <span class="n">beam_scores</span><span class="o">.</span><span class="n">view</span><span class="p">((</span><span class="n">batch_size</span> <span class="o">*</span> <span class="n">num_beams</span><span class="p">,))</span> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> <span class="c1"># prepare model inputs</span> <span class="c1"># From max_length-sized input_ids, select first</span> <span class="c1"># cur_len - 1 values.</span> <span class="n">update_indices</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">stack</span><span class="p">(</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">input_ids</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="mi">0</span><span class="p">)),</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">(</span><span class="n">cur_len</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">repeat</span><span class="p">(</span><span class="n">input_ids</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="mi">0</span><span class="p">))],</span> <span class="n">dim</span><span class="o">=-</span><span class="mi">1</span> <span class="p">)</span> <span class="n">input_ids_</span> <span class="o">=</span> <span class="n">input_ids</span><span class="p">[</span><span class="n">update_indices</span><span class="p">[:,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">update_indices</span><span class="p">[:,</span> <span class="mi">1</span><span class="p">],</span> <span class="kc">None</span><span class="p">]</span> <span class="n">model_inputs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepare_inputs_for_generation</span><span class="p">(</span><span class="n">input_ids_</span><span class="p">,</span> <span class="o">**</span><span class="n">model_kwargs</span><span class="p">)</span> <span class="n">next_token_scores</span><span class="p">,</span> <span class="n">next_tokens</span><span class="p">,</span> <span class="n">next_indices</span> <span class="o">=</span> <span class="bp">self</span><span class="p">(</span> <span class="o">**</span><span class="n">model_inputs</span><span class="p">,</span> <span class="n">return_dict</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">output_attentions</span><span class="o">=</span><span class="n">output_attentions</span><span class="p">,</span> <span class="n">output_hidden_states</span><span class="o">=</span><span class="n">output_hidden_states</span><span class="p">,</span> <span class="n">beam_scores</span><span class="o">=</span><span class="n">beam_scores</span> <span class="p">)</span> <span class="c1"># stateless</span> <span class="n">beam_outputs</span> <span class="o">=</span> <span class="n">beam_scorer</span><span class="o">.</span><span class="n">process</span><span class="p">(</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">)[:,</span> <span class="p">:</span><span class="n">cur_len</span><span class="p">],</span> <span class="n">next_token_scores</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">),</span> <span class="n">next_tokens</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">),</span> <span class="n">next_indices</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">),</span> <span class="n">pad_token_id</span><span class="o">=</span><span class="n">pad_token_id</span><span class="p">,</span> <span class="n">eos_token_id</span><span class="o">=</span><span class="n">eos_token_id</span><span class="p">,</span> <span class="n">beam_indices</span><span class="o">=</span><span class="n">beam_indices</span><span class="p">,</span> <span class="p">)</span> <span class="n">beam_scores</span> <span class="o">=</span> <span class="n">beam_outputs</span><span class="p">[</span><span class="s2">"next_beam_scores"</span><span class="p">]</span> <span class="n">beam_next_tokens</span> <span class="o">=</span> <span class="n">beam_outputs</span><span class="p">[</span><span class="s2">"next_beam_tokens"</span><span class="p">]</span> <span class="n">beam_idx</span> <span class="o">=</span> <span class="n">beam_outputs</span><span class="p">[</span><span class="s2">"next_beam_indices"</span><span class="p">]</span> <span class="n">update_indices</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">stack</span><span class="p">(</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">batch_beam_size</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">(</span><span class="n">cur_len</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">repeat</span><span class="p">(</span><span class="n">batch_beam_size</span><span class="p">)],</span> <span class="n">dim</span><span class="o">=-</span><span class="mi">1</span> <span class="p">)</span> <span class="n">update_indices_2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">stack</span><span class="p">(</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">batch_beam_size</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">(</span><span class="n">cur_len</span><span class="p">)</span><span class="o">.</span><span class="n">repeat</span><span class="p">(</span><span class="n">batch_beam_size</span><span class="p">)],</span> <span class="n">dim</span><span class="o">=-</span><span class="mi">1</span> <span class="p">)</span> <span class="c1"># First select beam_indices</span> <span class="n">device</span> <span class="o">=</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">device</span> <span class="n">beam_idx_device</span> <span class="o">=</span> <span class="n">beam_idx</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="o">=</span><span class="n">input_ids</span><span class="o">.</span><span class="n">device</span><span class="p">)</span> <span class="n">input_ids</span><span class="p">[:,</span> <span class="p">:]</span> <span class="o">=</span> <span class="n">input_ids</span><span class="p">[</span><span class="n">beam_idx_device</span><span class="o">.</span><span class="n">long</span><span class="p">(),</span> <span class="p">:]</span> <span class="c1"># Then append new tokens</span> <span class="n">input_ids</span><span class="p">[</span><span class="n">update_indices_2</span><span class="p">[:,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">update_indices_2</span><span class="p">[:,</span> <span class="mi">1</span><span class="p">],</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="n">beam_next_tokens</span><span class="o">.</span><span class="n">unsqueeze</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">long</span><span class="p">)</span> <span class="n">input_ids</span> <span class="o">=</span> <span class="n">input_ids</span> <span class="o">*</span> <span class="mi">1</span> <span class="c1"># Hack to materialize tensor</span> <span class="c1"># update generated ids, model inputs, and length for next step</span> <span class="n">model_kwargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_update_model_kwargs_for_xla_generation</span><span class="p">(</span> <span class="n">model_kwargs</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="n">batch_beam_size</span><span class="p">,</span> <span class="n">is_encoder_decoder</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">is_encoder_decoder</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">stopping_criteria</span><span class="o">.</span><span class="n">max_length</span><span class="p">,</span> <span class="n">seq_length</span><span class="o">=</span><span class="n">cur_len</span><span class="p">,</span> <span class="n">use_cache</span><span class="o">=</span><span class="n">model_kwargs</span><span class="p">[</span><span class="s2">"use_cache"</span><span class="p">],</span> <span class="p">)</span> <span class="k">if</span> <span class="n">model_kwargs</span><span class="p">[</span><span class="s2">"past_key_values"</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> <span class="n">model_kwargs</span><span class="p">[</span><span class="s2">"past_key_values"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_reorder_cache</span><span class="p">(</span><span class="n">model_kwargs</span><span class="p">[</span><span class="s2">"past_key_values"</span><span class="p">],</span> <span class="n">beam_idx</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">int64</span><span class="p">))</span> <span class="k">if</span> <span class="n">return_dict_in_generate</span> <span class="ow">and</span> <span class="n">output_scores</span><span class="p">:</span> <span class="n">beam_indices</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">((</span><span class="n">beam_indices</span><span class="p">[</span><span class="n">beam_idx</span><span class="p">[</span><span class="n">i</span><span class="p">]]</span> <span class="o">+</span> <span class="p">(</span><span class="n">beam_idx</span><span class="p">[</span><span class="n">i</span><span class="p">],)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">beam_indices</span><span class="p">))))</span> <span class="c1"># increase cur_len</span> <span class="n">cur_len</span> <span class="o">=</span> <span class="n">cur_len</span> <span class="o">+</span> <span class="mi">1</span> <span class="c1"># stop when each sentence is finished, or if we exceed the maximum length</span> <span class="n">stop_criterion_1</span> <span class="o">=</span> <span class="n">beam_scorer</span><span class="o">.</span><span class="n">is_done</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">stopping_criteria</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">stopping_criteria</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> <span class="n">stopping_criteria</span> <span class="o">=</span> <span class="n">stopping_criteria</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># Cases that can be handled in XLA without requiring</span> <span class="c1"># non-padded input_ids</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">stopping_criteria</span><span class="p">,</span> <span class="n">MaxLengthCriteria</span><span class="p">):</span> <span class="n">stop_criterion_2</span> <span class="o">=</span> <span class="n">cur_len</span> <span class="o">&gt;=</span> <span class="n">stopping_criteria</span><span class="o">.</span><span class="n">max_length</span> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">stopping_criteria</span><span class="p">,</span> <span class="n">MaxTimeCriteria</span><span class="p">):</span> <span class="n">stop_criterion_2</span> <span class="o">=</span> <span class="n">stopping_criteria</span><span class="p">(</span><span class="n">input_ids</span><span class="p">,</span> <span class="n">scores</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="c1"># Other cases will be handled on CPU</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">shape</span> <span class="n">input_ids_cpu</span> <span class="o">=</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">)</span> <span class="n">mask</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">(</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">cur_len</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">cur_len</span><span class="p">)],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span> <span class="p">)</span><span class="o">.</span><span class="n">bool</span><span class="p">()</span> <span class="n">input_ids_cpu</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">masked_select</span><span class="p">(</span><span class="n">input_ids_cpu</span><span class="p">,</span> <span class="n">mask</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">cur_len</span><span class="p">))</span> <span class="n">scores_cpu</span> <span class="o">=</span> <span class="n">scores</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">)</span> <span class="k">if</span> <span class="n">torch</span><span class="o">.</span><span class="n">is_tensor</span><span class="p">(</span><span class="n">scores</span><span class="p">)</span> <span class="k">else</span> <span class="n">scores</span> <span class="n">stop_criterion_2</span> <span class="o">=</span> <span class="n">stopping_criteria</span><span class="p">(</span><span class="n">input_ids_cpu</span><span class="p">,</span> <span class="n">scores_cpu</span><span class="p">)</span> <span class="k">if</span> <span class="n">stop_criterion_1</span> <span class="ow">or</span> <span class="n">stop_criterion_2</span><span class="p">:</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">synced_gpus</span><span class="p">:</span> <span class="k">break</span> <span class="k">else</span><span class="p">:</span> <span class="n">this_peer_finished</span> <span class="o">=</span> <span class="kc">True</span> <span class="n">sequence_outputs</span> <span class="o">=</span> <span class="n">beam_scorer</span><span class="o">.</span><span class="n">finalize</span><span class="p">(</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">),</span> <span class="n">beam_scores</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">),</span> <span class="n">next_tokens</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">),</span> <span class="n">next_indices</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">),</span> <span class="n">pad_token_id</span><span class="o">=</span><span class="n">pad_token_id</span><span class="p">,</span> <span class="n">eos_token_id</span><span class="o">=</span><span class="n">eos_token_id</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">stopping_criteria</span><span class="o">.</span><span class="n">max_length</span><span class="p">,</span> <span class="n">beam_indices</span><span class="o">=</span><span class="n">beam_indices</span><span class="p">,</span> <span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">sequence_outputs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="o">==</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">:</span> <span class="n">sequence_outputs</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">sequence_outputs</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">input_ids</span><span class="o">.</span><span class="n">device</span><span class="p">)</span> <span class="k">return</span> <span class="n">sequence_outputs</span><span class="p">[</span><span class="s2">"sequences"</span><span class="p">]</span> <span class="k">def</span> <span class="nf">greedy_search</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">input_ids</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">LongTensor</span><span class="p">,</span> <span class="n">logits_processor</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">LogitsProcessorList</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">stopping_criteria</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">StoppingCriteriaList</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">max_length</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">pad_token_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">eos_token_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="nb">int</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">output_attentions</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">output_hidden_states</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">output_scores</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">return_dict_in_generate</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">seq_length</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="nb">int</span><span class="p">,</span> <span class="n">streamer</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="s2">"BaseStreamer"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">model_kwargs</span><span class="p">,</span> <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="n">GreedySearchOutput</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">LongTensor</span><span class="p">]:</span> <span class="w"> </span><span class="sd">"""</span> <span class="sd"> Overriding greedy sampling to use next tokens returned from neuron device instead of logits.</span> <span class="sd"> """</span> <span class="c1"># init values</span> <span class="n">logits_processor</span> <span class="o">=</span> <span class="n">logits_processor</span> <span class="k">if</span> <span class="n">logits_processor</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">LogitsProcessorList</span><span class="p">()</span> <span class="n">use_cache</span> <span class="o">=</span> <span class="n">model_kwargs</span><span class="p">[</span><span class="s2">"use_cache"</span><span class="p">]</span> <span class="k">if</span> <span class="s2">"use_cache"</span> <span class="ow">in</span> <span class="n">model_kwargs</span> <span class="k">else</span> <span class="kc">False</span> <span class="n">stopping_criteria</span> <span class="o">=</span> <span class="n">stopping_criteria</span> <span class="k">if</span> <span class="n">stopping_criteria</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">StoppingCriteriaList</span><span class="p">()</span> <span class="n">pad_token_id</span> <span class="o">=</span> <span class="n">pad_token_id</span> <span class="k">if</span> <span class="n">pad_token_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">pad_token_id</span> <span class="n">eos_token_id</span> <span class="o">=</span> <span class="n">eos_token_id</span> <span class="k">if</span> <span class="n">eos_token_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">eos_token_id</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">eos_token_id</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span> <span class="n">eos_token_id</span> <span class="o">=</span> <span class="p">[</span><span class="n">eos_token_id</span><span class="p">]</span> <span class="n">eos_token_id_tensor</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">(</span><span class="n">eos_token_id</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">input_ids</span><span class="o">.</span><span class="n">device</span><span class="p">)</span> <span class="k">if</span> <span class="n">eos_token_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span> <span class="n">output_scores</span> <span class="o">=</span> <span class="n">output_scores</span> <span class="k">if</span> <span class="n">output_scores</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">output_scores</span> <span class="n">output_attentions</span> <span class="o">=</span> <span class="p">(</span> <span class="n">output_attentions</span> <span class="k">if</span> <span class="n">output_attentions</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">output_attentions</span> <span class="p">)</span> <span class="n">output_hidden_states</span> <span class="o">=</span> <span class="p">(</span> <span class="n">output_hidden_states</span> <span class="k">if</span> <span class="n">output_hidden_states</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">generation_config</span><span class="o">.</span><span class="n">output_hidden_states</span> <span class="p">)</span> <span class="c1"># init attention / hidden states / scores tuples</span> <span class="n">scores</span> <span class="o">=</span> <span class="p">()</span> <span class="k">if</span> <span class="p">(</span><span class="n">return_dict_in_generate</span> <span class="ow">and</span> <span class="n">output_scores</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span> <span class="n">decoder_attentions</span> <span class="o">=</span> <span class="p">()</span> <span class="k">if</span> <span class="p">(</span><span class="n">return_dict_in_generate</span> <span class="ow">and</span> <span class="n">output_attentions</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span> <span class="n">cross_attentions</span> <span class="o">=</span> <span class="p">()</span> <span class="k">if</span> <span class="p">(</span><span class="n">return_dict_in_generate</span> <span class="ow">and</span> <span class="n">output_attentions</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span> <span class="n">decoder_hidden_states</span> <span class="o">=</span> <span class="p">()</span> <span class="k">if</span> <span class="p">(</span><span class="n">return_dict_in_generate</span> <span class="ow">and</span> <span class="n">output_hidden_states</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span> <span class="c1"># keep track of which sequences are already finished</span> <span class="n">unfinished_sequences</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">input_ids</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">long</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="n">input_ids</span><span class="o">.</span><span class="n">device</span><span class="p">)</span> <span class="n">this_peer_finished</span> <span class="o">=</span> <span class="kc">False</span> <span class="c1"># used by synced_gpus only</span> <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> <span class="c1"># prepare model inputs</span> <span class="c1"># From max_length-sized input_ids, select first</span> <span class="c1"># seq_length - 1 values.</span> <span class="k">if</span> <span class="n">model_kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"past_key_values"</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="n">input_ids_</span> <span class="o">=</span> <span class="n">input_ids</span><span class="p">[:,</span> <span class="p">:</span><span class="n">seq_length</span><span class="p">]</span> <span class="k">else</span><span class="p">:</span> <span class="n">update_indices</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">stack</span><span class="p">(</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">input_ids</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="mi">0</span><span class="p">)),</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">(</span><span class="n">seq_length</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">repeat</span><span class="p">(</span><span class="n">input_ids</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="mi">0</span><span class="p">))],</span> <span class="n">dim</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="p">)</span> <span class="n">input_ids_</span> <span class="o">=</span> <span class="n">input_ids</span><span class="p">[</span><span class="n">update_indices</span><span class="p">[:,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">update_indices</span><span class="p">[:,</span> <span class="mi">1</span><span class="p">],</span> <span class="kc">None</span><span class="p">]</span> <span class="n">model_inputs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prepare_inputs_for_generation</span><span class="p">(</span><span class="n">input_ids_</span><span class="p">,</span> <span class="o">**</span><span class="n">model_kwargs</span><span class="p">)</span> <span class="c1"># forward pass to get next token</span> <span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="p">(</span> <span class="o">**</span><span class="n">model_inputs</span><span class="p">,</span> <span class="n">return_dict</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">output_attentions</span><span class="o">=</span><span class="n">output_attentions</span><span class="p">,</span> <span class="n">output_hidden_states</span><span class="o">=</span><span class="n">output_hidden_states</span><span class="p">,</span> <span class="p">)</span> <span class="n">next_tokens</span> <span class="o">=</span> <span class="n">output</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># finished sentences should have their next token be a padding token</span> <span class="k">if</span> <span class="n">eos_token_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> <span class="k">if</span> <span class="n">pad_token_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"If `eos_token_id` is defined, make sure that `pad_token_id` is defined."</span><span class="p">)</span> <span class="n">next_tokens</span> <span class="o">=</span> <span class="n">next_tokens</span> <span class="o">*</span> <span class="n">unfinished_sequences</span> <span class="o">+</span> <span class="n">pad_token_id</span> <span class="o">*</span> <span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="n">unfinished_sequences</span><span class="p">)</span> <span class="c1"># update generated ids, model inputs, and length for next step</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">shape</span> <span class="n">update_indices</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">stack</span><span class="p">(</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">batch_size</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">(</span><span class="n">seq_length</span><span class="p">)</span><span class="o">.</span><span class="n">repeat</span><span class="p">(</span><span class="n">batch_size</span><span class="p">)],</span> <span class="n">dim</span><span class="o">=-</span><span class="mi">1</span> <span class="p">)</span> <span class="n">input_ids</span><span class="p">[</span><span class="n">update_indices</span><span class="p">[:,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">update_indices</span><span class="p">[:,</span> <span class="mi">1</span><span class="p">]]</span> <span class="o">=</span> <span class="n">next_tokens</span><span class="p">[:]</span> <span class="n">model_kwargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_update_model_kwargs_for_xla_generation</span><span class="p">(</span> <span class="n">model_kwargs</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">is_encoder_decoder</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">is_encoder_decoder</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">stopping_criteria</span><span class="o">.</span><span class="n">max_length</span><span class="p">,</span> <span class="n">seq_length</span><span class="o">=</span><span class="n">seq_length</span><span class="p">,</span> <span class="n">use_cache</span><span class="o">=</span><span class="n">use_cache</span><span class="p">,</span> <span class="p">)</span> <span class="n">seq_length</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c1"># if eos_token was found in one sentence, set sentence to finished</span> <span class="k">if</span> <span class="n">eos_token_id_tensor</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> <span class="n">unfinished_sequences</span> <span class="o">=</span> <span class="n">unfinished_sequences</span><span class="o">.</span><span class="n">mul</span><span class="p">(</span> <span class="n">next_tokens</span><span class="o">.</span><span class="n">tile</span><span class="p">(</span><span class="n">eos_token_id_tensor</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">ne</span><span class="p">(</span><span class="n">eos_token_id_tensor</span><span class="o">.</span><span class="n">unsqueeze</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">dim</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="p">)</span> <span class="c1"># stop when each sentence is finished, or if we exceed the maximum length</span> <span class="n">stop_criterion_1</span> <span class="o">=</span> <span class="n">unfinished_sequences</span><span class="o">.</span><span class="n">max</span><span class="p">()</span> <span class="o">==</span> <span class="mi">0</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">stopping_criteria</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">stopping_criteria</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> <span class="n">stopping_criteria</span> <span class="o">=</span> <span class="n">stopping_criteria</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># Cases that can be handled in XLA without requiring</span> <span class="c1"># non-padded input_ids</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">stopping_criteria</span><span class="p">,</span> <span class="n">MaxLengthCriteria</span><span class="p">):</span> <span class="n">stop_criterion_2</span> <span class="o">=</span> <span class="n">seq_length</span> <span class="o">&gt;=</span> <span class="n">stopping_criteria</span><span class="o">.</span><span class="n">max_length</span> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">stopping_criteria</span><span class="p">,</span> <span class="n">MaxTimeCriteria</span><span class="p">):</span> <span class="n">stop_criterion_2</span> <span class="o">=</span> <span class="n">stopping_criteria</span><span class="p">(</span><span class="n">input_ids</span><span class="p">,</span> <span class="n">scores</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="c1"># Other cases will be handled on CPU</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">shape</span> <span class="n">mask</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">(</span> <span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">seq_length</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">input_ids</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">seq_length</span><span class="p">)],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="p">)</span><span class="o">.</span><span class="n">bool</span><span class="p">()</span> <span class="n">input_ids_cpu</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">masked_select</span><span class="p">(</span><span class="n">input_ids</span><span class="p">,</span> <span class="n">mask</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="n">batch_size</span><span class="p">,</span> <span class="n">seq_length</span><span class="p">))</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">)</span> <span class="n">scores_cpu</span> <span class="o">=</span> <span class="n">scores</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s2">"cpu"</span><span class="p">)</span> <span class="k">if</span> <span class="n">torch</span><span class="o">.</span><span class="n">is_tensor</span><span class="p">(</span><span class="n">scores</span><span class="p">)</span> <span class="k">else</span> <span class="n">scores</span> <span class="n">stop_criterion_2</span> <span class="o">=</span> <span class="n">stopping_criteria</span><span class="p">(</span><span class="n">input_ids_cpu</span><span class="p">,</span> <span class="n">scores_cpu</span><span class="p">)</span> <span class="k">if</span> <span class="n">stop_criterion_1</span> <span class="ow">or</span> <span class="n">stop_criterion_2</span><span class="p">:</span> <span class="n">this_peer_finished</span> <span class="o">=</span> <span class="kc">True</span> <span class="k">if</span> <span class="n">this_peer_finished</span><span class="p">:</span> <span class="k">break</span> <span class="k">if</span> <span class="n">streamer</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> <span class="n">streamer</span><span class="o">.</span><span class="n">end</span><span class="p">()</span> <span class="k">return</span> <span class="n">input_ids</span> <br></pre></div> </div> </div> <p>Now let’s test inference on CPU with all the wrappers before tracing.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[5]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Let's set some run parameters</span> <span class="n">model_name</span> <span class="o">=</span> <span class="s2">"t5-large"</span> <span class="n">num_beams</span> <span class="o">=</span> <span class="mi">1</span> <span class="n">num_return_sequences</span> <span class="o">=</span> <span class="mi">1</span> <span class="n">max_length</span> <span class="o">=</span> <span class="mi">128</span> </pre></div> </div> </div> <div class="nbinput docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[6]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">T5Tokenizer</span> <span class="n">prompt</span><span class="o">=</span><span class="s2">"translate English to German: Lets eat good food."</span> <span class="n">tokenizer</span> <span class="o">=</span> <span class="n">T5Tokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">,</span> <span class="n">model_max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">T5Wrapper</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">encoder</span> <span class="o">=</span> <span class="n">EncoderWrapper</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encoder</span><span class="p">,</span> <span class="n">model</span><span class="o">.</span><span class="n">decoder</span><span class="p">,</span> <span class="n">model</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="s2">"cpu"</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">)</span> <span class="nb">setattr</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encoder</span><span class="p">,</span> <span class="s1">'main_input_name'</span><span class="p">,</span> <span class="s1">'input_ids'</span><span class="p">)</span> <span class="c1"># Attribute required by beam search</span> <span class="n">model</span><span class="o">.</span><span class="n">decoder</span> <span class="o">=</span> <span class="n">DecoderWrapper</span><span class="p">(</span><span class="n">decoder</span><span class="o">=</span><span class="n">model</span><span class="o">.</span><span class="n">decoder</span><span class="p">,</span> <span class="n">lm_head</span><span class="o">=</span><span class="n">model</span><span class="o">.</span><span class="n">lm_head</span><span class="p">,</span> <span class="n">model_config</span><span class="o">=</span><span class="n">model</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="n">num_beams</span><span class="o">=</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="s2">"cpu"</span><span class="p">)</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="n">tokenizer</span><span class="o">=</span><span class="n">tokenizer</span><span class="p">,</span> <span class="n">prompt</span><span class="o">=</span><span class="n">prompt</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">,</span> <span class="n">num_beams</span><span class="o">=</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">num_return_sequences</span><span class="o">=</span><span class="n">num_return_sequences</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="s2">"cpu"</span><span class="p">)</span> <span class="n">results</span> <span class="o">=</span> <span class="p">[</span><span class="n">tokenizer</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">skip_special_tokens</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">output</span><span class="p">]</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Results:'</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">summary</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">results</span><span class="p">):</span> <span class="nb">print</span><span class="p">(</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">summary</span><span class="p">)</span> <br></pre></div> </div> </div> <div class="nboutput nblast docutils container"> <div class="prompt empty docutils container"> </div> <div class="output_area docutils container"> <div class="highlight"><pre>Results: 1 Lassen Sie uns gutes Essen essen. </pre></div></div> </div> <p>Now that the wrappers are running as expected, let’s trace the encoder, and decoder. To trace these functions, we pass the function and a sample input to the trace function. The result of the trace stage will be a static executable where the operations to be run upon inference are determined during compilation. This means that when inferring, the resulting Neuron model must be executed with tensors that are the exact same shape as those provided at compilation time. If a model is given a tensor at inference time whose shape does not match the tensor given at compilation time, an error will occur.</p> <p>The decoder wrapper returns the new state of the cache as an output which is copied back to the CPU. As the cache is a large tensor, copying it to and from the XLA device for each decoder invocation will significantly slow down the inference. Instead, we can use input output aliasing, a feature of <code class="docutils literal notranslate"><span class="pre">torch_neuronx</span></code> to keep these tensors on device rather than copying back to the CPU. To use input output aliasing, we need to map the outputs to input parameters while tracing.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">T5Tokenizer</span><span class="p">,</span> <span class="n">T5ForConditionalGeneration</span> <span class="k">def</span> <span class="nf">trace_encoder</span><span class="p">(</span><span class="n">model</span><span class="p">:</span> <span class="n">T5ForConditionalGeneration</span><span class="p">,</span> <span class="n">tokenizer</span><span class="p">:</span> <span class="n">T5Tokenizer</span><span class="p">,</span> <span class="n">max_length</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span> <span class="c1"># Trace encoder</span> <span class="n">batch_encoding</span> <span class="o">=</span> <span class="n">tokenizer</span><span class="p">(</span><span class="s2">"translate English to German: Lets go home now"</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">,</span> <span class="n">truncation</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">padding</span><span class="o">=</span><span class="s1">'max_length'</span><span class="p">,</span> <span class="n">return_tensors</span><span class="o">=</span><span class="s2">"pt"</span><span class="p">)</span> <span class="n">input_ids</span> <span class="o">=</span> <span class="n">batch_encoding</span><span class="p">[</span><span class="s1">'input_ids'</span><span class="p">]</span> <span class="n">attention_mask</span> <span class="o">=</span> <span class="n">batch_encoding</span><span class="p">[</span><span class="s1">'attention_mask'</span><span class="p">]</span> <span class="n">encoder</span> <span class="o">=</span> <span class="n">EncoderWrapper</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encoder</span><span class="p">,</span> <span class="n">model</span><span class="o">.</span><span class="n">decoder</span><span class="p">,</span> <span class="n">model</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="s2">"xla"</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">)</span> <span class="n">traced_encoder</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">encoder</span><span class="p">,</span> <span class="p">(</span><span class="n">input_ids</span><span class="p">,</span> <span class="n">attention_mask</span><span class="p">),</span> <span class="n">compiler_workdir</span><span class="o">=</span><span class="s2">"/tmp/encoder/"</span><span class="p">)</span> <span class="nb">setattr</span><span class="p">(</span><span class="n">traced_encoder</span><span class="p">,</span> <span class="s1">'main_input_name'</span><span class="p">,</span> <span class="s1">'input_ids'</span><span class="p">)</span> <span class="c1"># Attribute required by beam search</span> <span class="k">return</span> <span class="n">traced_encoder</span> <span class="k">def</span> <span class="nf">trace_decoder</span><span class="p">(</span><span class="n">model</span><span class="p">:</span> <span class="n">T5ForConditionalGeneration</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">max_length</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span> <span class="n">decoder</span> <span class="o">=</span> <span class="n">DecoderWrapper</span><span class="p">(</span><span class="n">decoder</span><span class="o">=</span><span class="n">model</span><span class="o">.</span><span class="n">decoder</span><span class="p">,</span> <span class="n">lm_head</span><span class="o">=</span><span class="n">model</span><span class="o">.</span><span class="n">lm_head</span><span class="p">,</span> <span class="n">model_config</span><span class="o">=</span><span class="n">model</span><span class="o">.</span><span class="n">config</span><span class="p">,</span> <span class="n">num_beams</span><span class="o">=</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="s2">"xla"</span><span class="p">)</span> <span class="c1"># We create mock inputs so we can trace the decoder</span> <span class="n">decoder_input_ids</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">num_beams</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">int64</span><span class="p">)</span> <span class="n">decoder_attention_mask</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">max_length</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">int32</span><span class="p">)</span> <span class="n">encoder_attention_mask</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">max_length</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">int64</span><span class="p">)</span> <span class="n">encoder_hidden_states</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="n">model</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">d_model</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span> <span class="n">beam_idx</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">int64</span><span class="p">)</span> <span class="n">beam_scores</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="n">num_beams</span><span class="p">,),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float</span><span class="p">)</span> <span class="n">num_outputs_from_trace</span> <span class="o">=</span> <span class="mi">3</span> <span class="k">if</span> <span class="n">num_beams</span> <span class="o">&gt;</span> <span class="mi">1</span> <span class="k">else</span> <span class="mi">1</span> <span class="n">aliases</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">decoder</span><span class="o">.</span><span class="n">past_key_values_sa</span><span class="p">)):</span> <span class="n">aliases</span><span class="p">[</span><span class="n">decoder</span><span class="o">.</span><span class="n">past_key_values_sa</span><span class="p">[</span><span class="n">i</span><span class="p">]]</span> <span class="o">=</span> <span class="n">i</span> <span class="o">+</span> <span class="n">num_outputs_from_trace</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">decoder</span><span class="o">.</span><span class="n">past_key_values_ca</span><span class="p">)):</span> <span class="n">aliases</span><span class="p">[</span><span class="n">decoder</span><span class="o">.</span><span class="n">past_key_values_ca</span><span class="p">[</span><span class="n">i</span><span class="p">]]</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">decoder</span><span class="o">.</span><span class="n">past_key_values_sa</span><span class="p">)</span> <span class="o">+</span> <span class="n">i</span> <span class="o">+</span> <span class="n">num_outputs_from_trace</span> <span class="n">traced_decoder</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">decoder</span><span class="p">,</span> <span class="p">(</span> <span class="n">decoder_input_ids</span><span class="p">,</span> <span class="n">decoder_attention_mask</span><span class="p">,</span> <span class="n">encoder_hidden_states</span><span class="p">,</span> <span class="n">encoder_attention_mask</span><span class="p">,</span> <span class="n">beam_idx</span><span class="p">,</span> <span class="n">beam_scores</span><span class="p">,</span> <span class="p">),</span> <span class="n">input_output_aliases</span><span class="o">=</span><span class="n">aliases</span><span class="p">,</span> <span class="n">compiler_workdir</span><span class="o">=</span><span class="s2">"/tmp/decoder/"</span><span class="p">)</span> <span class="k">return</span> <span class="n">traced_decoder</span> <span class="n">tokenizer</span> <span class="o">=</span> <span class="n">T5Tokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">,</span> <span class="n">model_max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">T5ForConditionalGeneration</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span> <span class="c1"># We enable this flag to ensure model uses attention key value caching</span> <span class="n">model</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">use_cache</span> <span class="o">=</span> <span class="kc">True</span> <span class="n">traced_encoder</span> <span class="o">=</span> <span class="n">trace_encoder</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">tokenizer</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">)</span> <span class="n">traced_decoder</span> <span class="o">=</span> <span class="n">trace_decoder</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">,</span> <span class="n">max_length</span><span class="p">)</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">traced_encoder</span><span class="p">,</span> <span class="s2">"TracedEncoder.pt"</span><span class="p">)</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">traced_decoder</span><span class="p">,</span> <span class="s2">"TracedDecoder.pt"</span><span class="p">)</span> <br></pre></div> </div> </div> </div> <div class="section" id="Run-inference-with-greedy-decoding"> <h2>Run inference with greedy decoding<a class="headerlink" href="#Run-inference-with-greedy-decoding" title="Permalink to this headline">#</a></h2> <p>Now that we have the traced model, let’s use it for inference.</p> <div class="nbinput docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[8]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">runtime</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">classes</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">Runtime</span><span class="p">()</span> <span class="n">runtime</span><span class="o">.</span><span class="n">initialize</span><span class="p">()</span> <span class="n">runtime</span><span class="o">.</span><span class="n">set_default_neuron_cores</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="n">tokenizer</span> <span class="o">=</span> <span class="n">T5Tokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">T5Wrapper</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">encoder</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s2">"TracedEncoder.pt"</span><span class="p">)</span> <span class="c1"># Attribute required by beam search</span> <span class="nb">setattr</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encoder</span><span class="p">,</span> <span class="s1">'main_input_name'</span><span class="p">,</span> <span class="s1">'input_ids'</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">decoder</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s2">"TracedDecoder.pt"</span><span class="p">)</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">move_trace_to_device</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">decoder</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="n">tokenizer</span><span class="o">=</span><span class="n">tokenizer</span><span class="p">,</span> <span class="n">prompt</span><span class="o">=</span><span class="s2">"translate English to German: Lets eat good food."</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">,</span> <span class="n">num_beams</span><span class="o">=</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">num_return_sequences</span><span class="o">=</span><span class="n">num_return_sequences</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="s2">"xla"</span><span class="p">)</span> <span class="n">results</span> <span class="o">=</span> <span class="p">[</span><span class="n">tokenizer</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">skip_special_tokens</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">output</span><span class="p">]</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Results:'</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">summary</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">results</span><span class="p">):</span> <span class="nb">print</span><span class="p">(</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">summary</span><span class="p">)</span> <br><br></pre></div> </div> </div> <div class="nboutput nblast docutils container"> <div class="prompt empty docutils container"> </div> <div class="output_area docutils container"> <div class="highlight"><pre>Results: 1 Lassen Sie uns gutes Essen essen. </pre></div></div> </div> </div> <div class="section" id="Run-inference-with-beam-search"> <h2>Run inference with beam search<a class="headerlink" href="#Run-inference-with-beam-search" title="Permalink to this headline">#</a></h2> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Let's set some run parameters for beam search</span> <span class="n">model_name</span> <span class="o">=</span> <span class="s2">"t5-large"</span> <span class="n">num_beams</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">num_return_sequences</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">max_length</span> <span class="o">=</span> <span class="mi">128</span> <span class="n">tokenizer</span> <span class="o">=</span> <span class="n">T5Tokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">,</span> <span class="n">model_max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">T5ForConditionalGeneration</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">use_cache</span> <span class="o">=</span> <span class="kc">True</span> <span class="n">traced_encoder</span> <span class="o">=</span> <span class="n">trace_encoder</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">tokenizer</span><span class="p">,</span> <span class="n">max_length</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">)</span> <span class="n">traced_decoder</span> <span class="o">=</span> <span class="n">trace_decoder</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">num_beams</span><span class="p">,</span> <span class="n">max_length</span><span class="p">)</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">traced_encoder</span><span class="p">,</span> <span class="s2">"TracedEncoder.pt"</span><span class="p">)</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">traced_decoder</span><span class="p">,</span> <span class="s2">"TracedDecoder.pt"</span><span class="p">)</span> </pre></div> </div> </div> <div class="nbinput docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[10]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">tokenizer</span> <span class="o">=</span> <span class="n">T5Tokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">T5Wrapper</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">encoder</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s2">"TracedEncoder.pt"</span><span class="p">)</span> <span class="c1"># Attribute required by beam search</span> <span class="nb">setattr</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encoder</span><span class="p">,</span> <span class="s1">'main_input_name'</span><span class="p">,</span> <span class="s1">'input_ids'</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">decoder</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s2">"TracedDecoder.pt"</span><span class="p">)</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">move_trace_to_device</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">decoder</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="n">tokenizer</span><span class="o">=</span><span class="n">tokenizer</span><span class="p">,</span> <span class="n">prompt</span><span class="o">=</span><span class="s2">"translate English to German: Lets eat good food."</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">max_length</span><span class="p">,</span> <span class="n">num_beams</span><span class="o">=</span><span class="n">num_beams</span><span class="p">,</span> <span class="n">num_return_sequences</span><span class="o">=</span><span class="n">num_return_sequences</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="s2">"xla"</span><span class="p">)</span> <span class="n">results</span> <span class="o">=</span> <span class="p">[</span><span class="n">tokenizer</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">skip_special_tokens</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">output</span><span class="p">]</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Results:'</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">summary</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">results</span><span class="p">):</span> <span class="nb">print</span><span class="p">(</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">summary</span><span class="p">)</span> </pre></div> </div> </div> <div class="nboutput nblast docutils container"> <div class="prompt empty docutils container"> </div> <div class="output_area docutils container"> <div class="highlight"><pre>Results: 1 Lassen Sie uns gutes Essen essen. 2 Lassen Sie uns gutes Essen zu essen. 3 Lassen Sie uns essen gutes Essen. 4 Lassen Sie uns gutes Essen. </pre></div></div> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="resnet50-inference-on-trn1-tutorial.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Compiling and Deploying ResNet50 on Trn1 or Inf2</p> </div> </a> <a class="right-next" id="next-link" href="../../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:48.130Z
API Reference Guide (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html
# API Reference Guide (torch-neuronx) — AWS Neuron Documentation previous Additional Examples (`torch-neuronx`)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>API Reference Guide (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuronx) Tracing API for Inference" href="api-torch-neuronx-trace.html"> <link rel="prev" title="Additional Examples (torch-neuronx)" href="../../additional-examples-inference-torch-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script type="text/javascript" src="/_/static/vendor/jquery.js"></script><script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>API Reference Guide (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="api-reference-guide-torch-neuronx"> <h1>API Reference Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#api-reference-guide-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> API Reference Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="api-torch-neuronx-trace.html#torch-neuronx-trace-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Tracing API for Inference</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="api-torch-neuronx-core-placement.html#torch-neuronx-core-placement-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs [Experimental]</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="api-torch-neuronx-analyze.html#torch-neuronx-analyze-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Analyze API for Inference</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="api-torch-neuronx-data-parallel.html#torch-neuronx-dataparallel-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) DataParallel API</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="api-torch-neuronx-async-lazy-load.html#torch-neuronx-lazy-async-load-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Lazy and Asynchronous Loading API</span></a></p></li> </ul> </div> </details><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../additional-examples-inference-torch-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="api-torch-neuronx-trace.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Tracing API for Inference</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:48.610Z
Additional Examples (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html
# Additional Examples (torch-neuronx) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.rst) - [.rst](../../../_sources/frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.rst.txt) ## Additional Examples (torch-neuronx) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Additional Examples (`torch-neuronx`)[#](#additional-examples-torch-neuronx "Permalink to this headline") - [AWS Neuron Samples GitHub Repository](https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/) - [Transformers Neuron GitHub samples](https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Additional Examples (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="API Reference Guide (torch-neuronx)" href="api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> <link rel="prev" title="T5 model inference on Trn1 or Inf2" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Additional Examples </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Additional Examples (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="additional-examples-torch-neuronx"> <h1>Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#additional-examples-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/">AWS Neuron Samples GitHub Repository</a></p></li> <li><p><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx">Transformers Neuron GitHub samples</a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">T5 model inference on Trn1 or Inf2</p> </div> </a> <a class="right-next" id="next-link" href="api-reference-guide/inference/inference-api-guide-torch-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">API Reference Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:48.890Z
PyTorch Neuron (torch-neuronx) Tracing API for Inference — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html
# PyTorch Neuron (torch-neuronx) Tracing API for Inference — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## PyTorch Neuron (`torch-neuronx`) Tracing API for Inference[#](#pytorch-neuron-torch-neuronx-tracing-api-for-inference "Permalink to this headline") torch\_neuronx.trace(_func_, _example\_inputs_, _\*_, _compiler\_workdir\=None_, _compiler\_args\=None_)[#](#torch_neuronx.trace "Permalink to this definition") Trace and compile operations in the `func` by executing it using `example_inputs`. This function is similar to a [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") since it produces a [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") that can be saved with [`torch.jit.save()`](https://pytorch.org/docs/master/generated/torch.jit.save.html#torch.jit.save "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") and reloaded with [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). The resulting module is an optimized fused graph representation of the `func` that is _only_ compatible with Neuron. Tracing a module produces a more efficient _inference-only_ version of the model. XLA Lazy Tensor execution should be used during training. See: [Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx)](../../programming-guide/inference/trace-vs-xla-lazytensor.html#trace-vs-xla-lazytensor) Parameters - **func** ([_Module_](https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_,__callable_) – The function/module that that will be run using the `example_inputs` arguments in order to record the computation graph. - **example\_inputs** ([_Tensor_](https://pytorch.org/docs/master/tensors.html#torch.Tensor "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_,_[_tuple_](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.11)")_\[_[_Tensor_](https://pytorch.org/docs/master/tensors.html#torch.Tensor "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_\]_) – A tuple of example inputs that will be passed to the `func` while tracing. Keyword Arguments - **compiler\_workdir** ([_str_](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.11)")) – Work directory used by [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide). This can be useful for debugging and/or inspecting intermediary [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) outputs - **compiler\_args** ([_str_](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.11)")_,_[_list_](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.11)")_\[_[_str_](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.11)")_\]_) – List of strings representing [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) compiler arguments. See [Neuron Compiler CLI Reference Guide (neuronx-cc)](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) for more information about compiler options. Returns The traced [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") with the embedded compiled Neuron graph. Operations in this module will execute on Neuron. Return type [_ScriptModule_](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") Notes This function records operations using [torch-xla](https://github.com/pytorch/xla) to create a HloModule representation of the `func`. This fixed graph representation is compiled to the Neuron Executable File Format (NEFF) using the [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) compiler. The NEFF binary executable is embedded into an optimized [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") for [torchscript](https://pytorch.org/docs/stable/jit.html) execution. In contrast to a regular [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") that produces a graph of many separate operations, tracing with Neuron produces a graph with a single fused operator that is executed entirely on device. In [torchscript](https://pytorch.org/docs/stable/jit.html) this appears as a stateful `neuron::Model` component with an associated `neuron::forward*` operation. Tracing can be performed on any EC2 machine with sufficient memory and compute resources, but inference can only be executed on a Neuron instance. Unlike some devices (such as [torch-xla](https://github.com/pytorch/xla)) that use [`to()`](https://pytorch.org/docs/master/generated/torch.Tensor.to.html#torch.Tensor.to "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to move [`Parameter`](https://pytorch.org/docs/master/generated/torch.nn.parameter.Parameter.html#torch.nn.parameter.Parameter "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") and [`Tensor`](https://pytorch.org/docs/master/tensors.html#torch.Tensor "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") data between CPU and device, upon loading a Neuron traced [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"), the model binary executable is automatically moved to a NeuronCore. When the underlying `neuron::Model` is initialized after tracing or upon [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"), it is loaded to a Neuron device without specifying a device or `map_location` argument. Furthermore, the Neuron traced [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") expects to consume CPU tensors and produces CPU tensors. The underlying operation performs all data transfers to and from the Neuron device without explicit data movement. This is a significant difference from the training XLA device mechanics since XLA operations are no longer required to be recorded after a trace. See: [Developer Guide for Training with PyTorch Neuron (torch-neuronx)](../../programming-guide/training/pytorch-neuron-programming-guide.html#pytorch-neuronx-programming-guide) By _default_, when multiple NeuronCores are available, every Neuron traced model [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") within in a process is loaded to each available NeuronCore in round-robin order. This is useful at deployment to fully utilize the Neuron hardware since it means that multiple calls to [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") will attempt to load to each available NeuronCore in linear order. The default start device is chosen according to the [Neuron Runtime Configuration](../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration). A traced Neuron module has limitations that are not present in regular torch modules: - **Fixed Control Flow**: Similar to [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"), tracing a model with Neuron statically preserves control flow (i.e. `if`/`for`/`while` statements) and will not re-evaluate the branch conditions upon inference. If a model result is based on data-dependent control flow, the traced function may produce inaccurate results. - **Fixed Input Shapes**: After a function has been traced, the resulting [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") will always expect to consume tensors of the same shape. If the tensor shapes used at inference differs from the tensor shapes used in the `example_inputs`, this will result in an error. See: [Running inference on variable input shapes with bucketing](../../../../../general/appnotes/torch-neuron/bucketing-app-note.html#bucketing-app-note). - **Fixed Tensor Shapes**: The intermediate tensors within the `func` must always stay the same shape for the same shaped inputs. This means that certain operations which produce data-dependent sized tensors are not supported. For example, [`nonzero()`](https://pytorch.org/docs/master/generated/torch.nonzero.html#torch.nonzero "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") produces a different tensor shape depending on the input data. - **Fixed Data Types**: After a model has been traced, the input, output, and intermediate data types cannot be changed without recompiling. - **Device Compatibility**: Due to Neuron using a specialized compiled format (NEFF), a model traced with Neuron can no longer be executed in any non-Neuron environment. - **Operator Support**: If an operator is unsupported by [torch-xla](https://github.com/pytorch/xla), then this will throw an exception. Examples _Function Compilation_ ``` import torch import torch_neuronx def func(x, y): return 2 * x + y example_inputs = torch.rand(3), torch.rand(3) # Runs `func` with the provided inputs and records the tensor operations trace = torch_neuronx.trace(func, example_inputs) # `trace` can now be run with the TorchScript interpreter or saved # and loaded in a Python-free environment torch.jit.save(trace, 'func.pt') # Executes on a NeuronCore loaded = torch.jit.load('func.pt') loaded(torch.rand(3), torch.rand(3)) ``` _Module Compilation_ ``` import torch import torch_neuronx import torch.nn as nn class Model(nn.Module): def __init__(self): super().__init__() self.conv = nn.Conv2d(1, 1, 3) def forward(self, x): return self.conv(x) + 1 model = Model() model.eval() example_inputs = torch.rand(1, 1, 3, 3) # Traces the forward method and constructs a `ScriptModule` trace = torch_neuronx.trace(model, example_inputs) torch.jit.save(trace, 'model.pt') # Executes on a NeuronCore loaded = torch.jit.load('model.pt') loaded(torch.rand(1, 1, 3, 3)) ``` ## Dynamic Batching[#](#dynamic-batching "Permalink to this headline") torch\_neuronx.dynamic\_batch(_neuron\_script_)[#](#torch_neuronx.dynamic_batch "Permalink to this definition") Enables a compiled Neuron model to be called with variable sized batches. When tracing with Neuron, usually a model can only consume tensors that are the same size as the example tensor used in the [`torch_neuronx.trace()`](#torch_neuronx.trace "torch_neuronx.trace") call. Enabling dynamic batching allows a model to consume inputs that may be either smaller or larger than the original trace-time tensor size. Internally, dynamic batching splits & pads an input batch into chunks of size equal to the original trace-time tensor size. These chunks are passed to the underlying model(s). Compared to serial inference, the expected runtime scales by `ceil(inference_batch_size / trace_batch_size) / neuron_cores`. This function modifies the `neuron_script` network in-place. The returned result is a reference to the modified input. Dynamic batching is only supported by chunking inputs along the 0th dimension. A network that uses a non-0 batch dimension is incompatible with dynamic batching. Upon inference, inputs whose shapes differ from the compile-time shape in a non-0 dimension will raise a ValueError. For example, take a model was traced with a single example input of size `[2, 3, 5]`. At inference time, when dynamic batching is enabled, a batch of size `[3, 3, 5]` is _valid_ while a batch of size `[2, 7, 5]` is _invalid_ due to changing a non-0 dimension. Dynamic batching is only supported when the 0th dimension is the same size for all inputs. For example, this means that dynamic batching would not be applicable to a network which consumed two inputs with shapes `[1, 2]` and `[3, 2]` since the 0th dimension is different. Similarly, at inference time, the 0th dimension batch size for all inputs must be identical otherwise a ValueError will be raised. _Required Arguments_ Parameters **neuron\_script** ([_ScriptModule_](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")) – The neuron traced [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") with the embedded compiled neuron graph. This is the output of [`torch_neuronx.trace()`](#torch_neuronx.trace "torch_neuronx.trace"). Returns The traced [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") with the embedded compiled neuron graph. The same type as the input, but with dynamic\_batch enabled in the neuron graph. Return type [_ScriptModule_](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") ``` import torch import torch_neuronx import torch.nn as nn class Net(nn.Module): def __init__(self): super(Net, self).__init__() self.conv = nn.Conv2d(1, 1, 3) def forward(self, x): return self.conv(x) + 1 n = Net() n.eval() inputs = torch.rand(1, 1, 3, 3) inputs_batch_8 = torch.rand(8, 1, 3, 3) # Trace a neural network with input batch size of 1 neuron_net = torch_neuronx.trace(n, inputs) # Enable the dynamic batch size feature so the traced network # can consume variable sized batch inputs neuron_net_dynamic_batch = torch_neuronx.dynamic_batch(neuron_net) # Run inference on inputs with batch size of 8 # different than the batch size used in compilation (tracing) ouput_batch_8 = neuron_net_dynamic_batch(inputs_batch_8) ``` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuronx) Tracing API for Inference — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs [Experimental]" href="api-torch-neuronx-core-placement.html"> <link rel="prev" title="API Reference Guide (torch-neuronx)" href="inference-api-guide-torch-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic Batching </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuronx) Tracing API for Inference</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic Batching </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-torch-neuronx-tracing-api-for-inference"> <span id="torch-neuronx-trace-api"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Tracing API for Inference<a class="headerlink" href="#pytorch-neuron-torch-neuronx-tracing-api-for-inference" title="Permalink to this headline">#</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.trace"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.</span></span><span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">example_inputs</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compiler_workdir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compiler_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.trace" title="Permalink to this definition">#</a></dt> <dd><p>Trace and compile operations in the <code class="docutils literal notranslate"><span class="pre">func</span></code> by executing it using <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code>.</p> <p>This function is similar to a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a> since it produces a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> that can be saved with <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.save.html#torch.jit.save" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.save()</span></code></a> and reloaded with <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>. The resulting module is an optimized fused graph representation of the <code class="docutils literal notranslate"><span class="pre">func</span></code> that is <em>only</em> compatible with Neuron.</p> <p>Tracing a module produces a more efficient <em>inference-only</em> version of the model. XLA Lazy Tensor execution should be used during training. See: <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html#trace-vs-xla-lazytensor"><span class="std std-ref">Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx)</span></a></p> <div class="admonition warning"> <p class="admonition-title">Warning</p> <p>Currently this only supports <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuron-core-v2.html#neuroncores-v2-arch"><span class="std std-ref">NeuronCore-v2</span></a> type instances (e.g. <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html#aws-trn1-arch"><span class="std std-ref">trn1</span></a>, inf2). To compile models compatible with <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuron-core-v1.html#neuroncores-v1-arch"><span class="std std-ref">NeuronCore-v1</span></a> (e.g. <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html#aws-inf1-arch"><span class="std std-ref">inf1</span></a>), please see <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a></p> </div> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>func</strong> (<a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>Module</em></a><em>,</em><em>callable</em>) – The function/module that that will be run using the <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> arguments in order to record the computation graph.</p></li> <li><p><strong>example_inputs</strong> (<a class="reference external" href="https://pytorch.org/docs/master/tensors.html#torch.Tensor" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>Tensor</em></a><em>,</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><em>tuple</em></a><em>[</em><a class="reference external" href="https://pytorch.org/docs/master/tensors.html#torch.Tensor" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>Tensor</em></a><em>]</em>) – A tuple of example inputs that will be passed to the <code class="docutils literal notranslate"><span class="pre">func</span></code> while tracing.</p></li> </ul> </dd> <dt class="field-even">Keyword Arguments</dt> <dd class="field-even"><ul class="simple"> <li><p><strong>compiler_workdir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – Work directory used by <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a>. This can be useful for debugging and/or inspecting intermediary <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a> outputs</p></li> <li><p><strong>compiler_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>,</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – List of strings representing <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a> compiler arguments. See <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">Neuron Compiler CLI Reference Guide (neuronx-cc)</span></a> for more information about compiler options.</p></li> </ul> </dd> <dt class="field-odd">Returns</dt> <dd class="field-odd"><p>The traced <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> with the embedded compiled Neuron graph. Operations in this module will execute on Neuron.</p> </dd> <dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>ScriptModule</em></a></p> </dd> </dl> <p class="rubric">Notes</p> <p>This function records operations using <a class="reference external" href="https://github.com/pytorch/xla">torch-xla</a> to create a HloModule representation of the <code class="docutils literal notranslate"><span class="pre">func</span></code>. This fixed graph representation is compiled to the Neuron Executable File Format (NEFF) using the <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a> compiler. The NEFF binary executable is embedded into an optimized <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> for <a class="reference external" href="https://pytorch.org/docs/stable/jit.html">torchscript</a> execution.</p> <p>In contrast to a regular <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a> that produces a graph of many separate operations, tracing with Neuron produces a graph with a single fused operator that is executed entirely on device. In <a class="reference external" href="https://pytorch.org/docs/stable/jit.html">torchscript</a> this appears as a stateful <code class="docutils literal notranslate"><span class="pre">neuron::Model</span></code> component with an associated <code class="docutils literal notranslate"><span class="pre">neuron::forward*</span></code> operation.</p> <p>Tracing can be performed on any EC2 machine with sufficient memory and compute resources, but inference can only be executed on a Neuron instance.</p> <p>Unlike some devices (such as <a class="reference external" href="https://github.com/pytorch/xla">torch-xla</a>) that use <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.Tensor.to.html#torch.Tensor.to" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-meth docutils literal notranslate"><span class="pre">to()</span></code></a> to move <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.parameter.Parameter.html#torch.nn.parameter.Parameter" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parameter</span></code></a> and <a class="reference external" href="https://pytorch.org/docs/master/tensors.html#torch.Tensor" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a> data between CPU and device, upon loading a Neuron traced <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a>, the model binary executable is automatically moved to a NeuronCore. When the underlying <code class="docutils literal notranslate"><span class="pre">neuron::Model</span></code> is initialized after tracing or upon <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>, it is loaded to a Neuron device without specifying a device or <code class="docutils literal notranslate"><span class="pre">map_location</span></code> argument.</p> <p>Furthermore, the Neuron traced <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> expects to consume CPU tensors and produces CPU tensors. The underlying operation performs all data transfers to and from the Neuron device without explicit data movement. This is a significant difference from the training XLA device mechanics since XLA operations are no longer required to be recorded after a trace. See: <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html#pytorch-neuronx-programming-guide"><span class="std std-ref">Developer Guide for Training with PyTorch Neuron (torch-neuronx)</span></a></p> <p>By <em>default</em>, when multiple NeuronCores are available, every Neuron traced model <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> within in a process is loaded to each available NeuronCore in round-robin order. This is useful at deployment to fully utilize the Neuron hardware since it means that multiple calls to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a> will attempt to load to each available NeuronCore in linear order. The default start device is chosen according to the <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration"><span class="std std-ref">Neuron Runtime Configuration</span></a>.</p> <p>A traced Neuron module has limitations that are not present in regular torch modules:</p> <ul class="simple"> <li><p><strong>Fixed Control Flow</strong>: Similar to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a>, tracing a model with Neuron statically preserves control flow (i.e. <code class="docutils literal notranslate"><span class="pre">if</span></code>/<code class="docutils literal notranslate"><span class="pre">for</span></code>/<code class="docutils literal notranslate"><span class="pre">while</span></code> statements) and will not re-evaluate the branch conditions upon inference. If a model result is based on data-dependent control flow, the traced function may produce inaccurate results.</p></li> <li><p><strong>Fixed Input Shapes</strong>: After a function has been traced, the resulting <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> will always expect to consume tensors of the same shape. If the tensor shapes used at inference differs from the tensor shapes used in the <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code>, this will result in an error. See: <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html#bucketing-app-note"><span class="std std-ref">Running inference on variable input shapes with bucketing</span></a>.</p></li> <li><p><strong>Fixed Tensor Shapes</strong>: The intermediate tensors within the <code class="docutils literal notranslate"><span class="pre">func</span></code> must always stay the same shape for the same shaped inputs. This means that certain operations which produce data-dependent sized tensors are not supported. For example, <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nonzero.html#torch.nonzero" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">nonzero()</span></code></a> produces a different tensor shape depending on the input data.</p></li> <li><p><strong>Fixed Data Types</strong>: After a model has been traced, the input, output, and intermediate data types cannot be changed without recompiling.</p></li> <li><p><strong>Device Compatibility</strong>: Due to Neuron using a specialized compiled format (NEFF), a model traced with Neuron can no longer be executed in any non-Neuron environment.</p></li> <li><p><strong>Operator Support</strong>: If an operator is unsupported by <a class="reference external" href="https://github.com/pytorch/xla">torch-xla</a>, then this will throw an exception.</p></li> </ul> <p class="rubric">Examples</p> <p><em>Function Compilation</em></p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span> <span class="k">return</span> <span class="mi">2</span> <span class="o">*</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span> <span class="n">example_inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">3</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="c1"># Runs `func` with the provided inputs and records the tensor operations</span> <span class="n">trace</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">)</span> <span class="c1"># `trace` can now be run with the TorchScript interpreter or saved</span> <span class="c1"># and loaded in a Python-free environment</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">trace</span><span class="p">,</span> <span class="s1">'func.pt'</span><span class="p">)</span> <span class="c1"># Executes on a NeuronCore</span> <span class="n">loaded</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'func.pt'</span><span class="p">)</span> <span class="n">loaded</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">3</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">3</span><span class="p">))</span> </pre></div> </div> <p><em>Module Compilation</em></p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Model</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">example_inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c1"># Traces the forward method and constructs a `ScriptModule`</span> <span class="n">trace</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">)</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">trace</span><span class="p">,</span> <span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Executes on a NeuronCore</span> <span class="n">loaded</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="n">loaded</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span> </pre></div> </div> </dd></dl> <div class="section" id="dynamic-batching"> <span id="torch-neuronx-dynamic-batching"></span><h2>Dynamic Batching<a class="headerlink" href="#dynamic-batching" title="Permalink to this headline">#</a></h2> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.dynamic_batch"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.</span></span><span class="sig-name descname"><span class="pre">dynamic_batch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">neuron_script</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.dynamic_batch" title="Permalink to this definition">#</a></dt> <dd><p>Enables a compiled Neuron model to be called with variable sized batches.</p> <p>When tracing with Neuron, usually a model can only consume tensors that are the same size as the example tensor used in the <a class="reference internal" href="#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a> call. Enabling dynamic batching allows a model to consume inputs that may be either smaller or larger than the original trace-time tensor size. Internally, dynamic batching splits &amp; pads an input batch into chunks of size equal to the original trace-time tensor size. These chunks are passed to the underlying model(s). Compared to serial inference, the expected runtime scales by <code class="docutils literal notranslate"><span class="pre">ceil(inference_batch_size</span> <span class="pre">/</span> <span class="pre">trace_batch_size)</span> <span class="pre">/</span> <span class="pre">neuron_cores</span></code>.</p> <p>This function modifies the <code class="docutils literal notranslate"><span class="pre">neuron_script</span></code> network in-place. The returned result is a reference to the modified input.</p> <p>Dynamic batching is only supported by chunking inputs along the 0th dimension. A network that uses a non-0 batch dimension is incompatible with dynamic batching. Upon inference, inputs whose shapes differ from the compile-time shape in a non-0 dimension will raise a ValueError. For example, take a model was traced with a single example input of size <code class="docutils literal notranslate"><span class="pre">[2,</span> <span class="pre">3,</span> <span class="pre">5]</span></code>. At inference time, when dynamic batching is enabled, a batch of size <code class="docutils literal notranslate"><span class="pre">[3,</span> <span class="pre">3,</span> <span class="pre">5]</span></code> is <em>valid</em> while a batch of size <code class="docutils literal notranslate"><span class="pre">[2,</span> <span class="pre">7,</span> <span class="pre">5]</span></code> is <em>invalid</em> due to changing a non-0 dimension.</p> <p>Dynamic batching is only supported when the 0th dimension is the same size for all inputs. For example, this means that dynamic batching would not be applicable to a network which consumed two inputs with shapes <code class="docutils literal notranslate"><span class="pre">[1,</span> <span class="pre">2]</span></code> and <code class="docutils literal notranslate"><span class="pre">[3,</span> <span class="pre">2]</span></code> since the 0th dimension is different. Similarly, at inference time, the 0th dimension batch size for all inputs must be identical otherwise a ValueError will be raised.</p> <p><em>Required Arguments</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>neuron_script</strong> (<a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>ScriptModule</em></a>) – The neuron traced <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> with the embedded compiled neuron graph. This is the output of <a class="reference internal" href="#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>.</p> </dd> <dt class="field-even">Returns</dt> <dd class="field-even"><p>The traced <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> with the embedded compiled neuron graph. The same type as the input, but with dynamic_batch enabled in the neuron graph.</p> </dd> <dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>ScriptModule</em></a></p> </dd> </dl> </dd></dl> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="k">class</span> <span class="nc">Net</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">(</span><span class="n">Net</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="n">n</span> <span class="o">=</span> <span class="n">Net</span><span class="p">()</span> <span class="n">n</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="n">inputs_batch_8</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c1"># Trace a neural network with input batch size of 1</span> <span class="n">neuron_net</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">inputs</span><span class="p">)</span> <span class="c1"># Enable the dynamic batch size feature so the traced network</span> <span class="c1"># can consume variable sized batch inputs</span> <span class="n">neuron_net_dynamic_batch</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">dynamic_batch</span><span class="p">(</span><span class="n">neuron_net</span><span class="p">)</span> <span class="c1"># Run inference on inputs with batch size of 8</span> <span class="c1"># different than the batch size used in compilation (tracing)</span> <span class="n">ouput_batch_8</span> <span class="o">=</span> <span class="n">neuron_net_dynamic_batch</span><span class="p">(</span><span class="n">inputs_batch_8</span><span class="p">)</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="inference-api-guide-torch-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">API Reference Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="api-torch-neuronx-core-placement.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) NeuronCore Placement APIs <strong>[Experimental]</strong></p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:49.470Z
PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs [Experimental] — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html
# PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs \[Experimental\] — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## PyTorch Neuron (`torch-neuronx`) NeuronCore Placement APIs **\[Experimental\]**[#](#pytorch-neuron-torch-neuronx-neuroncore-placement-apis-experimental "Permalink to this headline") Warning The following functionality is experimental and **will not be supported** in future releases of the NeuronSDK. This module serves only as a preview for future functionality. In future releases, equivalent functionality may be moved directly to the `torch_neuronx` module and will no longer be available in the `torch_neuronx.experimental` module. Functions which enable placement of [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to specific NeuronCores. Two sets of functions are provided which can be used interchangeably but have different performance characteristics and advantages: - The [`multicore_context()`](#torch_neuronx.experimental.multicore_context "torch_neuronx.experimental.multicore_context") & [`neuron_cores_context()`](#torch_neuronx.experimental.neuron_cores_context "torch_neuronx.experimental.neuron_cores_context") functions are context managers that allow a model to be placed on a given NeuronCore _only_ at [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") time. These functions are the most efficient way of loading a model since the model is loaded directly to a NeuronCore. The alternative functions described below require that a model is unloaded from one core and then reloaded to another. - The [`set_multicore()`](#torch_neuronx.experimental.set_multicore "torch_neuronx.experimental.set_multicore") & [`set_neuron_cores()`](#torch_neuronx.experimental.set_neuron_cores "torch_neuronx.experimental.set_neuron_cores") functions allow a model that has already been loaded to a NeuronCore to be moved to a different NeuronCore. This functionality is less efficient than directly loading a model to a NeuronCore within a context manager but allows device placement to be fully dynamic at runtime. This is analogous to the [`torch.nn.Module.to()`](https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module.to "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function for device placement. torch\_neuronx.experimental.set\_neuron\_cores(_trace: [torch.jit.ScriptModule](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_, _start\_nc: [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") \= \- 1_, _nc\_count: [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") \= \- 1_)[#](#torch_neuronx.experimental.set_neuron_cores "Permalink to this definition") Set the NeuronCore start/count for all Neuron subgraphs in a torch Module. This will unload the model from an existing NeuronCore if it is already loaded. _Requires Torch 1.8+_ Parameters **trace** ([_ScriptModule_](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")) – A torch module which contains one or more Neuron subgraphs. Keyword Arguments - **start\_nc** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – The starting NeuronCore index where the Module is placed. The value `-1` automatically loads to the optimal NeuronCore (least used). Note that this index is always relative to NeuronCores visible to this process. - **nc\_count** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – The number of NeuronCores to use. The value `-1` will load a model to exactly one NeuronCore. If `nc_count` is greater than than one, the model will be replicated across multiple NeuronCores. Raises - **\[**[**RuntimeError**](https://docs.python.org/3/library/exceptions.html#RuntimeError "(in Python v3.11)")**\]** – If the Neuron runtime cannot be initialized. - **\[**[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.11)")**\]** – If the `nc_count` is an invalid number of NeuronCores. Examples _Single Load_: Move a model to the first visible NeuronCore after loading. ``` model = torch.jit.load('example_neuron_model.pt') torch_neuronx.experimental.set_neuron_cores(model, start_nc=0, nc_count=1) model(example) # Executes on NeuronCore 0 model(example) # Executes on NeuronCore 0 model(example) # Executes on NeuronCore 0 ``` _Multiple Core Replication_: Replicate a model to 2 NeuronCores after loading. This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use multiple NeuronCores by running round-robin executions. ``` model = torch.jit.load('example_neuron_model.pt') torch_neuronx.experimental.set_neuron_cores(model, start_nc=2, nc_count=2) model(example) # Executes on NeuronCore 2 model(example) # Executes on NeuronCore 3 model(example) # Executes on NeuronCore 2 ``` _Multiple Model Load_: Move and pin 2 models to separate NeuronCores. This causes each [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to always execute on a specific NeuronCore. ``` model1 = torch.jit.load('example_neuron_model.pt') torch_neuronx.experimental.set_neuron_cores(model1, start_nc=2) model2 = torch.jit.load('example_neuron_model.pt') torch_neuronx.experimental.set_neuron_cores(model2, start_nc=0) model1(example) # Executes on NeuronCore 2 model1(example) # Executes on NeuronCore 2 model2(example) # Executes on NeuronCore 0 model2(example) # Executes on NeuronCore 0 ``` torch\_neuronx.experimental.set\_multicore(_trace: [torch.jit.ScriptModule](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_)[#](#torch_neuronx.experimental.set_multicore "Permalink to this definition") Loads all Neuron subgraphs in a torch Module to all visible NeuronCores. This loads each Neuron subgraph within a [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to multiple NeuronCores without requiring multiple calls to [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use multiple NeuronCores for concurrent threadsafe inferences. Executions use a round-robin strategy to distribute across NeuronCores. This will unload the model from an existing NeuronCore if it is already loaded. _Requires Torch 1.8+_ Parameters **trace** ([_ScriptModule_](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")) – A torch module which contains one or more Neuron subgraphs. Raises **\[**[**RuntimeError**](https://docs.python.org/3/library/exceptions.html#RuntimeError "(in Python v3.11)")**\]** – If the Neuron runtime cannot be initialized. Examples _Multiple Core Replication_: Move a model across all visible NeuronCores after loading. This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use all NeuronCores by running round-robin executions. ``` model = torch.jit.load('example_neuron_model.pt') torch_neuronx.experimental.set_multicore(model) model(example) # Executes on NeuronCore 0 model(example) # Executes on NeuronCore 1 model(example) # Executes on NeuronCore 2 ``` torch\_neuronx.experimental.neuron\_cores\_context(_start\_nc: [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") \= \- 1_, _nc\_count: [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") \= \- 1_)[#](#torch_neuronx.experimental.neuron_cores_context "Permalink to this definition") A context which sets the NeuronCore start/count for Neuron models loaded with [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). This context manager may only be used when loading a model with [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). A model which has already been loaded into memory will not be affected by this context manager. Furthermore, after loading the model, inferences do not need to occur in this context in order to use the correct NeuronCores. Note that this context is _not_ threadsafe. Using multiple core placement contexts from multiple threads may not correctly place models. Keyword Arguments - **start\_nc** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – The starting NeuronCore index where the Module is placed. The value `-1` automatically loads to the optimal NeuronCore (least used). Note that this index is always relative to NeuronCores visible to this process. - **nc\_count** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – The number of NeuronCores to use. The value `-1` will load a model to exactly one NeuronCore. If `nc_count` is greater than than one, the model will be replicated across multiple NeuronCores. Raises - **\[**[**RuntimeError**](https://docs.python.org/3/library/exceptions.html#RuntimeError "(in Python v3.11)")**\]** – If the Neuron runtime cannot be initialized. - **\[**[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.11)")**\]** – If the `nc_count` is an invalid number of NeuronCores. Examples _Single Load_: Directly load a model from disk to the first visible NeuronCore. ``` with torch_neuronx.experimental.neuron_cores_context(start_nc=0, nc_count=1): model = torch.jit.load('example_neuron_model.pt') # Load must occur within the context model(example) # Executes on NeuronCore 0 model(example) # Executes on NeuronCore 0 model(example) # Executes on NeuronCore 0 ``` _Multiple Core Replication_: Directly load a model from disk to 2 NeuronCores. This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use multiple NeuronCores by running round-robin executions. ``` with torch_neuronx.experimental.neuron_cores_context(start_nc=2, nc_count=2): model = torch.jit.load('example_neuron_model.pt') # Load must occur within the context model(example) # Executes on NeuronCore 2 model(example) # Executes on NeuronCore 3 model(example) # Executes on NeuronCore 2 ``` _Multiple Model Load_: Directly load 2 models from disk and pin them to separate NeuronCores. This causes each [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to always execute on a specific NeuronCore. ``` with torch_neuronx.experimental.neuron_cores_context(start_nc=2): model1 = torch.jit.load('example_neuron_model.pt') # Load must occur within the context with torch_neuronx.experimental.neuron_cores_context(start_nc=0): model2 = torch.jit.load('example_neuron_model.pt') # Load must occur within the context model1(example) # Executes on NeuronCore 2 model1(example) # Executes on NeuronCore 2 model2(example) # Executes on NeuronCore 0 model2(example) # Executes on NeuronCore 0 ``` torch\_neuronx.experimental.multicore\_context()[#](#torch_neuronx.experimental.multicore_context "Permalink to this definition") A context manager which loads models to all visible NeuronCores for Neuron models loaded with [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). This loads each Neuron subgraph within a [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to multiple NeuronCores without requiring multiple calls to [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use multiple NeuronCores for concurrent threadsafe inferences. Executions use a round-robin strategy to distribute across NeuronCores. This context manager may only be used when loading a model with [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). A model which has already been loaded into memory will not be affected by this context manager. Furthermore, after loading the model, inferences do not need to occur in this context in order to use the correct NeuronCores. Note that this context is _not_ threadsafe. Using multiple core placement contexts from multiple threads may not correctly place models. Raises **\[**[**RuntimeError**](https://docs.python.org/3/library/exceptions.html#RuntimeError "(in Python v3.11)")**\]** – If the Neuron runtime cannot be initialized. Examples _Multiple Core Replication_: Directly load a model to all visible NeuronCores. This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use all NeuronCores by running round-robin executions. ``` with torch_neuronx.experimental.multicore_context(): model = torch.jit.load('example_neuron_model.pt') # Load must occur within the context model(example) # Executes on NeuronCore 0 model(example) # Executes on NeuronCore 1 model(example) # Executes on NeuronCore 2 ``` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs [Experimental] — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuronx) Analyze API for Inference" href="api-torch-neuronx-analyze.html"> <link rel="prev" title="PyTorch Neuron (torch-neuronx) Tracing API for Inference" href="api-torch-neuronx-trace.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs [Experimental]</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-torch-neuronx-neuroncore-placement-apis-experimental"> <span id="torch-neuronx-core-placement-api"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) NeuronCore Placement APIs <strong>[Experimental]</strong><a class="headerlink" href="#pytorch-neuron-torch-neuronx-neuroncore-placement-apis-experimental" title="Permalink to this headline">#</a></h1> <div class="admonition warning"> <p class="admonition-title">Warning</p> <p>The following functionality is experimental and <strong>will not be supported</strong> in future releases of the NeuronSDK. This module serves only as a preview for future functionality. In future releases, equivalent functionality may be moved directly to the <code class="code docutils literal notranslate"><span class="pre">torch_neuronx</span></code> module and will no longer be available in the <code class="code docutils literal notranslate"><span class="pre">torch_neuronx.experimental</span></code> module.</p> </div> <p>Functions which enable placement of <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to specific NeuronCores. Two sets of functions are provided which can be used interchangeably but have different performance characteristics and advantages:</p> <ul class="simple"> <li><p>The <a class="reference internal" href="#torch_neuronx.experimental.multicore_context" title="torch_neuronx.experimental.multicore_context"><code class="xref py py-func docutils literal notranslate"><span class="pre">multicore_context()</span></code></a> &amp; <a class="reference internal" href="#torch_neuronx.experimental.neuron_cores_context" title="torch_neuronx.experimental.neuron_cores_context"><code class="xref py py-func docutils literal notranslate"><span class="pre">neuron_cores_context()</span></code></a> functions are context managers that allow a model to be placed on a given NeuronCore <em>only</em> at <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a> time. These functions are the most efficient way of loading a model since the model is loaded directly to a NeuronCore. The alternative functions described below require that a model is unloaded from one core and then reloaded to another.</p></li> <li><p>The <a class="reference internal" href="#torch_neuronx.experimental.set_multicore" title="torch_neuronx.experimental.set_multicore"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_multicore()</span></code></a> &amp; <a class="reference internal" href="#torch_neuronx.experimental.set_neuron_cores" title="torch_neuronx.experimental.set_neuron_cores"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_neuron_cores()</span></code></a> functions allow a model that has already been loaded to a NeuronCore to be moved to a different NeuronCore. This functionality is less efficient than directly loading a model to a NeuronCore within a context manager but allows device placement to be fully dynamic at runtime. This is analogous to the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module.to" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-meth docutils literal notranslate"><span class="pre">torch.nn.Module.to()</span></code></a> function for device placement.</p></li> </ul> <div class="admonition important"> <p class="admonition-title">Important</p> <p>A prerequisite to enable placement functionality is that the loaded <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> has already been compiled with the <a class="reference internal" href="api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a> API. Attempting to place a regular <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.Module</span></code></a> onto a NeuronCore prior to compilation will do nothing.</p> </div> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.experimental.set_neuron_cores"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.experimental.</span></span><span class="sig-name descname"><span class="pre">set_neuron_cores</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><span class="pre">torch.jit.ScriptModule</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_nc</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nc_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.experimental.set_neuron_cores" title="Permalink to this definition">#</a></dt> <dd><p>Set the NeuronCore start/count for all Neuron subgraphs in a torch Module.</p> <p>This will unload the model from an existing NeuronCore if it is already loaded.</p> <p><em>Requires Torch 1.8+</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>trace</strong> (<a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>ScriptModule</em></a>) – A torch module which contains one or more Neuron subgraphs.</p> </dd> <dt class="field-even">Keyword Arguments</dt> <dd class="field-even"><ul class="simple"> <li><p><strong>start_nc</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – The starting NeuronCore index where the Module is placed. The value <code class="docutils literal notranslate"><span class="pre">-1</span></code> automatically loads to the optimal NeuronCore (least used). Note that this index is always relative to NeuronCores visible to this process.</p></li> <li><p><strong>nc_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – The number of NeuronCores to use. The value <code class="docutils literal notranslate"><span class="pre">-1</span></code> will load a model to exactly one NeuronCore. If <code class="docutils literal notranslate"><span class="pre">nc_count</span></code> is greater than than one, the model will be replicated across multiple NeuronCores.</p></li> </ul> </dd> <dt class="field-odd">Raises</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>[</strong><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a><strong>]</strong> – If the Neuron runtime cannot be initialized.</p></li> <li><p><strong>[</strong><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a><strong>]</strong> – If the <code class="docutils literal notranslate"><span class="pre">nc_count</span></code> is an invalid number of NeuronCores.</p></li> </ul> </dd> </dl> <p class="rubric">Examples</p> <p><em>Single Load</em>: Move a model to the first visible NeuronCore after loading.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_neuron_cores</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">start_nc</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> </pre></div> </div> <p><em>Multiple Core Replication</em>: Replicate a model to 2 NeuronCores after loading. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use multiple NeuronCores by running round-robin executions.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_neuron_cores</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">start_nc</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 3</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> </pre></div> </div> <p><em>Multiple Model Load</em>: Move and pin 2 models to separate NeuronCores. This causes each <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to always execute on a specific NeuronCore.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">model1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_neuron_cores</span><span class="p">(</span><span class="n">model1</span><span class="p">,</span> <span class="n">start_nc</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="n">model2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_neuron_cores</span><span class="p">(</span><span class="n">model2</span><span class="p">,</span> <span class="n">start_nc</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="n">model1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="n">model1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="n">model2</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="n">model2</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> </pre></div> </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.experimental.set_multicore"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.experimental.</span></span><span class="sig-name descname"><span class="pre">set_multicore</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><span class="pre">torch.jit.ScriptModule</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.experimental.set_multicore" title="Permalink to this definition">#</a></dt> <dd><p>Loads all Neuron subgraphs in a torch Module to all visible NeuronCores.</p> <p>This loads each Neuron subgraph within a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to multiple NeuronCores without requiring multiple calls to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use multiple NeuronCores for concurrent threadsafe inferences. Executions use a round-robin strategy to distribute across NeuronCores.</p> <p>This will unload the model from an existing NeuronCore if it is already loaded.</p> <p><em>Requires Torch 1.8+</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>trace</strong> (<a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>ScriptModule</em></a>) – A torch module which contains one or more Neuron subgraphs.</p> </dd> <dt class="field-even">Raises</dt> <dd class="field-even"><p><strong>[</strong><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a><strong>]</strong> – If the Neuron runtime cannot be initialized.</p> </dd> </dl> <p class="rubric">Examples</p> <p><em>Multiple Core Replication</em>: Move a model across all visible NeuronCores after loading. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use all NeuronCores by running round-robin executions.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_multicore</span><span class="p">(</span><span class="n">model</span><span class="p">)</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 1</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> </pre></div> </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.experimental.neuron_cores_context"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.experimental.</span></span><span class="sig-name descname"><span class="pre">neuron_cores_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start_nc</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nc_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.experimental.neuron_cores_context" title="Permalink to this definition">#</a></dt> <dd><p>A context which sets the NeuronCore start/count for Neuron models loaded with <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>.</p> <p>This context manager may only be used when loading a model with <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>. A model which has already been loaded into memory will not be affected by this context manager. Furthermore, after loading the model, inferences do not need to occur in this context in order to use the correct NeuronCores.</p> <p>Note that this context is <em>not</em> threadsafe. Using multiple core placement contexts from multiple threads may not correctly place models.</p> <dl class="field-list simple"> <dt class="field-odd">Keyword Arguments</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>start_nc</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – The starting NeuronCore index where the Module is placed. The value <code class="docutils literal notranslate"><span class="pre">-1</span></code> automatically loads to the optimal NeuronCore (least used). Note that this index is always relative to NeuronCores visible to this process.</p></li> <li><p><strong>nc_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – The number of NeuronCores to use. The value <code class="docutils literal notranslate"><span class="pre">-1</span></code> will load a model to exactly one NeuronCore. If <code class="docutils literal notranslate"><span class="pre">nc_count</span></code> is greater than than one, the model will be replicated across multiple NeuronCores.</p></li> </ul> </dd> <dt class="field-even">Raises</dt> <dd class="field-even"><ul class="simple"> <li><p><strong>[</strong><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a><strong>]</strong> – If the Neuron runtime cannot be initialized.</p></li> <li><p><strong>[</strong><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a><strong>]</strong> – If the <code class="docutils literal notranslate"><span class="pre">nc_count</span></code> is an invalid number of NeuronCores.</p></li> </ul> </dd> </dl> <p class="rubric">Examples</p> <p><em>Single Load</em>: Directly load a model from disk to the first visible NeuronCore.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="c1"># Load must occur within the context</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> </pre></div> </div> <p><em>Multiple Core Replication</em>: Directly load a model from disk to 2 NeuronCores. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use multiple NeuronCores by running round-robin executions.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="c1"># Load must occur within the context</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 3</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> </pre></div> </div> <p><em>Multiple Model Load</em>: Directly load 2 models from disk and pin them to separate NeuronCores. This causes each <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to always execute on a specific NeuronCore.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span> <span class="n">model1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="c1"># Load must occur within the context</span> <span class="k">with</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span> <span class="n">model2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="c1"># Load must occur within the context</span> <span class="n">model1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="n">model1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="n">model2</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="n">model2</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> </pre></div> </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.experimental.multicore_context"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.experimental.</span></span><span class="sig-name descname"><span class="pre">multicore_context</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.experimental.multicore_context" title="Permalink to this definition">#</a></dt> <dd><p>A context manager which loads models to all visible NeuronCores for Neuron models loaded with <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>.</p> <p>This loads each Neuron subgraph within a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to multiple NeuronCores without requiring multiple calls to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use multiple NeuronCores for concurrent threadsafe inferences. Executions use a round-robin strategy to distribute across NeuronCores.</p> <p>This context manager may only be used when loading a model with <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>. A model which has already been loaded into memory will not be affected by this context manager. Furthermore, after loading the model, inferences do not need to occur in this context in order to use the correct NeuronCores.</p> <p>Note that this context is <em>not</em> threadsafe. Using multiple core placement contexts from multiple threads may not correctly place models.</p> <dl class="field-list simple"> <dt class="field-odd">Raises</dt> <dd class="field-odd"><p><strong>[</strong><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a><strong>]</strong> – If the Neuron runtime cannot be initialized.</p> </dd> </dl> <p class="rubric">Examples</p> <p><em>Multiple Core Replication</em>: Directly load a model to all visible NeuronCores. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use all NeuronCores by running round-robin executions.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">multicore_context</span><span class="p">():</span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="c1"># Load must occur within the context</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 1</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> </pre></div> </div> </dd></dl> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-torch-neuronx-trace.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Tracing API for Inference</p> </div> </a> <a class="right-next" id="next-link" href="api-torch-neuronx-analyze.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Analyze API for Inference</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:50.140Z
PyTorch Neuron (torch-neuronx) Analyze API for Inference — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html
# PyTorch Neuron (torch-neuronx) Analyze API for Inference — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## PyTorch Neuron (`torch-neuronx`) Analyze API for Inference[#](#pytorch-neuron-torch-neuronx-analyze-api-for-inference "Permalink to this headline") torch\_neuronx.analyze(_func_, _example\_inputs_, _compiler\_workdir\=None_)[#](#torch_neuronx.analyze "Permalink to this definition") Checks the support of the operations in the `func` by checking each operator against neuronx-cc. Parameters - **func** ([_Module_](https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_,__callable_) – The function/module that that will be run using the `example_inputs` arguments in order to record the computation graph. - **example\_inputs** ([_Tensor_](https://pytorch.org/docs/master/tensors.html#torch.Tensor "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_,_[_tuple_](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.11)")_\[_[_Tensor_](https://pytorch.org/docs/master/tensors.html#torch.Tensor "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_\]_) – A tuple of example inputs that will be passed to the `func` while tracing. Keyword Arguments - **compiler\_workdir** ([_str_](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.11)")) – Work directory used by [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide). This can be useful for debugging and/or inspecting intermediary [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) outputs - **additional\_ignored\_ops** ([_set_](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.11)")) – A set of aten operators to not analyze. Default is an empty set. - **max\_workers** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – The max number of workers threads to spawn. The default is `4`. - **is\_hf\_transformers** ([_bool_](https://docs.python.org/3/library/functions.html#bool "(in Python v3.11)")) – If the model is a huggingface transformers model, it is recommended to enable this option to prevent deadlocks. Default is `False`. - **cleanup** ([_bool_](https://docs.python.org/3/library/functions.html#bool "(in Python v3.11)")) – Specifies whether to delete the compiler artifact directories generated after running analyze. Default is `False`. Returns A JSON like `Dict` with the supported operators and their count, and unsupported operators with the failure mode and location of the operator in the python code. Return type `Dict` Examples _Fully supported model_ ``` import json import torch import torch.nn as nn import torch_neuronx class MLP(nn.Module): def __init__(self, input_size=28*28, output_size=10, layers=[120,84]): super(MLP, self).__init__() self.fc1 = nn.Linear(input_size, layers[0]) self.relu = nn.ReLU() self.fc2 = nn.Linear(layers[0], layers[1]) def forward(self, x): f1 = self.fc1(x) r1 = self.relu(f1) f2 = self.fc2(r1) r2 = self.relu(f2) f3 = self.fc3(r2) return torch.log_softmax(f3, dim=1) model = MLP() ex_input = torch.rand([32,784]) model_support = torch_neuronx.analyze(model,ex_input) print(json.dumps(model_support,indent=4)) ``` ``` { "torch_neuronx_version": "1.13.0.1.5.0", "neuronx_cc_version": "2.0.0.11796a0+24a26e112", "support_percentage": "100.00%", "supported_operators": { "aten::linear": 3, "aten::relu": 2, "aten::log_softmax": 1 }, "unsupported_operators": [] } ``` _Unsupported Model/Operator_ ``` import json import torch import torch_neuronx def fft(x): return torch.fft.fft(x) model = fft ex_input = torch.arange(4) model_support = torch_neuronx.analyze(model,ex_input) print(json.dumps(model_support,indent=4)) ``` ``` { "torch_neuronx_version": "1.13.0.1.5.0", "neuronx_cc_version": "2.0.0.11796a0+24a26e112", "support_percentage": "0.00%", "supported_operators": {}, "unsupported_operators": [ { "kind": "aten::fft_fft", "failureAt": "neuronx-cc", "call": "test.py(6): fft\n/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch_neuronx/xla_impl/analyze.py(35): forward\n/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch/nn/modules/module.py(1182): _slow_forward\n/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch/nn/modules/module.py(1194): _call_impl\n/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch/jit/_trace.py(976): trace_module\n/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch/jit/_trace.py(759): trace\n/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch_neuronx/xla_impl/analyze.py(302): analyze\ntest.py(11): <module>\n", "opGraph": "graph(%x : Long(4, strides=[1], requires_grad=0, device=cpu),\n %neuron_4 : NoneType,\n %neuron_5 : int,\n %neuron_6 : NoneType):\n %neuron_7 : ComplexFloat(4, strides=[1], requires_grad=0, device=cpu) = aten::fft_fft(%x, %neuron_4, %neuron_5, %neuron_6)\n return (%neuron_7)\n" } ] } ``` **Note:** the `failureAt` field can either be “neuronx-cc” or “Lowering to HLO”. If the field is “neuronx-cc”, then it indicates that the provided operator configuration failed to be compiled with `neuronx-cc`. This could either indicate that the operator configuration is unsupported, or there is a bug with that operator configuration. _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuronx) Analyze API for Inference — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuronx) DataParallel API" href="api-torch-neuronx-data-parallel.html"> <link rel="prev" title="PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs [Experimental]" href="api-torch-neuronx-core-placement.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuronx) Analyze API for Inference</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-torch-neuronx-analyze-api-for-inference"> <span id="torch-neuronx-analyze-api"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Analyze API for Inference<a class="headerlink" href="#pytorch-neuron-torch-neuronx-analyze-api-for-inference" title="Permalink to this headline">#</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.analyze"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.</span></span><span class="sig-name descname"><span class="pre">analyze</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">example_inputs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compiler_workdir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.analyze" title="Permalink to this definition">#</a></dt> <dd><p>Checks the support of the operations in the <code class="docutils literal notranslate"><span class="pre">func</span></code> by checking each operator against neuronx-cc.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>func</strong> (<a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>Module</em></a><em>,</em><em>callable</em>) – The function/module that that will be run using the <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> arguments in order to record the computation graph.</p></li> <li><p><strong>example_inputs</strong> (<a class="reference external" href="https://pytorch.org/docs/master/tensors.html#torch.Tensor" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>Tensor</em></a><em>,</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><em>tuple</em></a><em>[</em><a class="reference external" href="https://pytorch.org/docs/master/tensors.html#torch.Tensor" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>Tensor</em></a><em>]</em>) – A tuple of example inputs that will be passed to the <code class="docutils literal notranslate"><span class="pre">func</span></code> while tracing.</p></li> </ul> </dd> <dt class="field-even">Keyword Arguments</dt> <dd class="field-even"><ul class="simple"> <li><p><strong>compiler_workdir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – Work directory used by <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a>. This can be useful for debugging and/or inspecting intermediary <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a> outputs</p></li> <li><p><strong>additional_ignored_ops</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.11)"><em>set</em></a>) – A set of aten operators to not analyze. Default is an empty set.</p></li> <li><p><strong>max_workers</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – The max number of workers threads to spawn. The default is <code class="docutils literal notranslate"><span class="pre">4</span></code>.</p></li> <li><p><strong>is_hf_transformers</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – If the model is a huggingface transformers model, it is recommended to enable this option to prevent deadlocks. Default is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li> <li><p><strong>cleanup</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – Specifies whether to delete the compiler artifact directories generated after running analyze. Default is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li> </ul> </dd> <dt class="field-odd">Returns</dt> <dd class="field-odd"><p>A JSON like <code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code> with the supported operators and their count, and unsupported operators with the failure mode and location of the operator in the python code.</p> </dd> <dt class="field-even">Return type</dt> <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></p> </dd> </dl> <p class="rubric">Examples</p> <p><em>Fully supported model</em></p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">json</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="k">class</span> <span class="nc">MLP</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">input_size</span><span class="o">=</span><span class="mi">28</span><span class="o">*</span><span class="mi">28</span><span class="p">,</span> <span class="n">output_size</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">layers</span><span class="o">=</span><span class="p">[</span><span class="mi">120</span><span class="p">,</span><span class="mi">84</span><span class="p">]):</span> <span class="nb">super</span><span class="p">(</span><span class="n">MLP</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc1</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">input_size</span><span class="p">,</span> <span class="n">layers</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="bp">self</span><span class="o">.</span><span class="n">relu</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">ReLU</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc2</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">layers</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">layers</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="n">f1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc1</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="n">r1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">relu</span><span class="p">(</span><span class="n">f1</span><span class="p">)</span> <span class="n">f2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc2</span><span class="p">(</span><span class="n">r1</span><span class="p">)</span> <span class="n">r2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">relu</span><span class="p">(</span><span class="n">f2</span><span class="p">)</span> <span class="n">f3</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc3</span><span class="p">(</span><span class="n">r2</span><span class="p">)</span> <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">log_softmax</span><span class="p">(</span><span class="n">f3</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">MLP</span><span class="p">()</span> <span class="n">ex_input</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">32</span><span class="p">,</span><span class="mi">784</span><span class="p">])</span> <span class="n">model_support</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">analyze</span><span class="p">(</span><span class="n">model</span><span class="p">,</span><span class="n">ex_input</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">model_support</span><span class="p">,</span><span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">))</span> </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"torch_neuronx_version"</span><span class="p">:</span> <span class="s2">"1.13.0.1.5.0"</span><span class="p">,</span> <span class="s2">"neuronx_cc_version"</span><span class="p">:</span> <span class="s2">"2.0.0.11796a0+24a26e112"</span><span class="p">,</span> <span class="s2">"support_percentage"</span><span class="p">:</span> <span class="s2">"100.00%"</span><span class="p">,</span> <span class="s2">"supported_operators"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"aten::linear"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s2">"aten::relu"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">"aten::log_softmax"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">},</span> <span class="s2">"unsupported_operators"</span><span class="p">:</span> <span class="p">[]</span> <span class="p">}</span> </pre></div> </div> <p><em>Unsupported Model/Operator</em></p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">json</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="k">def</span> <span class="nf">fft</span><span class="p">(</span><span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">fft</span><span class="o">.</span><span class="n">fft</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">fft</span> <span class="n">ex_input</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span> <span class="n">model_support</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">analyze</span><span class="p">(</span><span class="n">model</span><span class="p">,</span><span class="n">ex_input</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">model_support</span><span class="p">,</span><span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">))</span> </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"torch_neuronx_version"</span><span class="p">:</span> <span class="s2">"1.13.0.1.5.0"</span><span class="p">,</span> <span class="s2">"neuronx_cc_version"</span><span class="p">:</span> <span class="s2">"2.0.0.11796a0+24a26e112"</span><span class="p">,</span> <span class="s2">"support_percentage"</span><span class="p">:</span> <span class="s2">"0.00%"</span><span class="p">,</span> <span class="s2">"supported_operators"</span><span class="p">:</span> <span class="p">{},</span> <span class="s2">"unsupported_operators"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"kind"</span><span class="p">:</span> <span class="s2">"aten::fft_fft"</span><span class="p">,</span> <span class="s2">"failureAt"</span><span class="p">:</span> <span class="s2">"neuronx-cc"</span><span class="p">,</span> <span class="s2">"call"</span><span class="p">:</span> <span class="s2">"test.py(6): fft</span><span class="se">\n</span><span class="s2">/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch_neuronx/xla_impl/analyze.py(35): forward</span><span class="se">\n</span><span class="s2">/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch/nn/modules/module.py(1182): _slow_forward</span><span class="se">\n</span><span class="s2">/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch/nn/modules/module.py(1194): _call_impl</span><span class="se">\n</span><span class="s2">/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch/jit/_trace.py(976): trace_module</span><span class="se">\n</span><span class="s2">/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch/jit/_trace.py(759): trace</span><span class="se">\n</span><span class="s2">/home/ubuntu/testdir/venv/lib/python3.8/site-packages/torch_neuronx/xla_impl/analyze.py(302): analyze</span><span class="se">\n</span><span class="s2">test.py(11): &lt;module&gt;</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"opGraph"</span><span class="p">:</span> <span class="s2">"graph(</span><span class="si">%x</span><span class="s2"> : Long(4, strides=[1], requires_grad=0, device=cpu),</span><span class="se">\n</span><span class="s2"> %neuron_4 : NoneType,</span><span class="se">\n</span><span class="s2"> %neuron_5 : int,</span><span class="se">\n</span><span class="s2"> %neuron_6 : NoneType):</span><span class="se">\n</span><span class="s2"> %neuron_7 : ComplexFloat(4, strides=[1], requires_grad=0, device=cpu) = aten::fft_fft(</span><span class="si">%x</span><span class="s2">, %neuron_4, %neuron_5, %neuron_6)</span><span class="se">\n</span><span class="s2"> return (%neuron_7)</span><span class="se">\n</span><span class="s2">"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> <p><strong>Note:</strong> the <code class="docutils literal notranslate"><span class="pre">failureAt</span></code> field can either be “neuronx-cc” or “Lowering to HLO”. If the field is “neuronx-cc”, then it indicates that the provided operator configuration failed to be compiled with <code class="docutils literal notranslate"><span class="pre">neuronx-cc</span></code>. This could either indicate that the operator configuration is unsupported, or there is a bug with that operator configuration.</p> </dd></dl> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-torch-neuronx-core-placement.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) NeuronCore Placement APIs <strong>[Experimental]</strong></p> </div> </a> <a class="right-next" id="next-link" href="api-torch-neuronx-data-parallel.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) DataParallel API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:50.328Z
PyTorch Neuron (torch-neuronx) DataParallel API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html
# PyTorch Neuron (torch-neuronx) DataParallel API — AWS Neuron Documentation ## Contents - [Examples](#examples) - [Default usage](#default-usage) - [Specifying NeuronCores](#specifying-neuroncores) - [DataParallel with dim != 0](#dataparallel-with-dim-0) - [Dynamic batching](#dynamic-batching) - [Dynamic batching disabled](#dynamic-batching-disabled) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## PyTorch Neuron (`torch-neuronx`) DataParallel API[#](#pytorch-neuron-torch-neuronx-dataparallel-api "Permalink to this headline") The [`torch_neuronx.DataParallel()`](#torch_neuronx.DataParallel "torch_neuronx.DataParallel") Python API implements data parallelism on [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") models created by [PyTorch Neuron (torch-neuronx) Tracing API for Inference](api-torch-neuronx-trace.html#torch-neuronx-trace-api). This function is analogous to [`DataParallel`](https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") in PyTorch. The [Data Parallel Inference on torch\_neuronx](../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html#torch-neuronx-dataparallel-app-note) application note provides an overview of how [`torch_neuronx.DataParallel()`](#torch_neuronx.DataParallel "torch_neuronx.DataParallel") can be used to improve the performance of inference workloads on Inferentia. torch\_neuronx.DataParallel(_model_, _device\_ids\=None_, _dim\=0_, _set\_dynamic\_batching\=True_)[#](#torch_neuronx.DataParallel "Permalink to this definition") Applies data parallelism by replicating the model on available NeuronCores and distributing data across the different NeuronCores for parallelized inference. By default, DataParallel will use all available NeuronCores allocated for the current process for parallelism. DataParallel will apply parallelism on `dim=0` if `dim` is not specified. DataParallel automatically enables [dynamic batching](../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html#dynamic-batching-description-torch-neuronx) on eligible models if `dim=0`. Dynamic batching can be disabled using `torch_neuronx.DataParallel.disable_dynamic_batching()`, or by setting `set_dynamic_batching=False` when initializing the DataParallel object. If dynamic batching is not enabled, the batch size at compilation-time must be equal to the batch size at inference-time divided by the number of NeuronCores being used. Specifically, the following must be true when dynamic batching is disabled: `input.shape[dim] / len(device_ids) == compilation_input.shape[dim]`. [`torch.neuron.DataParallel()`](../../../torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") requires PyTorch >= 1.8. _Required Arguments_ Parameters **model** ([_ScriptModule_](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")) – Model created by the [PyTorch Neuron (torch-neuronx) Tracing API for Inference](api-torch-neuronx-trace.html#torch-neuronx-trace-api) to be parallelized. _Optional Arguments_ Parameters - **device\_ids** ([_list_](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.11)")) – List of [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") or `'nc:#'` that specify the NeuronCores to use for parallelization (default: all NeuronCores). Refer to the [device\_ids note](#device-ids-note-torch-neuronx) for a description of how `device_ids` indexing works. - **dim** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – Dimension along which the input tensor is scattered across NeuronCores (default `dim=0`). - **set\_dynamic\_batching** ([_bool_](https://docs.python.org/3/library/functions.html#bool "(in Python v3.11)")) – Whether to enable dynamic batching. _Attributes_ Parameters - **num\_workers** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – Number of worker threads used for multithreaded inference (default: `2 * number of NeuronCores`). - **split\_size** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – Size of the input chunks (default: `max(1, input.shape[dim] // number of NeuronCores)`). torch.neuron.DataParallel.disable\_dynamic\_batching()[#](#torch.neuron.DataParallel.disable_dynamic_batching "Permalink to this definition") Disables automatic dynamic batching on the DataParallel module. See [Dynamic batching disabled](#dataparallel-example-disable-dynamic-batching-api-torch-neuronx) for example of how DataParallel can be used with dynamic batching disabled. Use as follows: ``` >>> model_parallel = torch_neuronx.DataParallel(model_neuron) >>> model_parallel.disable_dynamic_batching() ``` Note `device_ids` uses per-process NeuronCore granularity and zero-based indexing. Per-process granularity means that each Python process “sees” its own view of the world. Specifically, this means that `device_ids` only “sees” the NeuronCores that are allocated for the current process. Zero-based indexing means that each Python process will index its allocated NeuronCores starting at 0, regardless of the “global” index of the NeuronCores. Zero-based indexing makes it possible to redeploy the exact same code unchanged in different process. This behavior is analogous to the `device_ids` argument in the PyTorch [`DataParallel`](https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function. As an example, assume DataParallel is run on an inf2.48xlarge, which contains 12 Inferentia chips each of which contains two NeuronCores: - If `NEURON_RT_VISIBLE_CORES` is not set, a single process can access all 24 NeuronCores. Thus specifying `device_ids=["nc:0"]` will correspond to chip0:core0 and `device_ids=["nc:13"]` will correspond to chip6:core1. - However, if two processes are launched where: process 1 has `NEURON_RT_VISIBLE_CORES=0-11` and process 2 has `NEURON_RT_VISIBLE_CORES=12-23`, `device_ids=["nc:13"]` cannot be specified in either process. Instead, chip6:core1 can only be accessed in process 2. Additionally, chip6:core1 is specified in process 2 with `device_ids=["nc:1"]`. Furthermore, in process 1, `device_ids=["nc:0"]` would correspond to chip0:core0; in process 2 `device_ids=["nc:0"]` would correspond to chip6:core0. ## Examples[#](#examples "Permalink to this headline") The following sections provide example usages of the [`torch_neuronx.DataParallel()`](#torch_neuronx.DataParallel "torch_neuronx.DataParallel") module. ### Default usage[#](#default-usage "Permalink to this headline") The default DataParallel use mode will replicate the model on all available NeuronCores in the current process. The inputs will be split on `dim=0`. ``` import torch import torch_neuronx from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module model_parallel = torch_neuronx.DataParallel(model_neuron) # Create a batched input batch_size = 5 image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### Specifying NeuronCores[#](#specifying-neuroncores "Permalink to this headline") The following example uses the `device_ids` argument to use the first three NeuronCores for DataParallel inference. ``` import torch import torch_neuronx from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module, run on the first two NeuronCores # Equivalent to model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1]) model_parallel = torch_neuronx.DataParallel(model_neuron, device_ids=['nc:0', 'nc:1']) # Create a batched input batch_size = 5 image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### DataParallel with dim != 0[#](#dataparallel-with-dim-0 "Permalink to this headline") In this example we run DataParallel inference using two NeuronCores and `dim = 2`. Because `dim != 0`, dynamic batching is not enabled. Consequently, the DataParallel inference-time batch size must be two times the compile-time batch size. ``` import torch import torch_neuronx # Create an example model class Model(torch.nn.Module): def __init__(self): super().__init__() self.conv = torch.nn.Conv2d(3, 3, 3) def forward(self, x): return self.conv(x) + 1 model = Model() model.eval() # Compile with an example input image = torch.rand([1, 3, 8, 8]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module using 2 NeuronCores and dim = 2 model_parallel = torch_neuronx.DataParallel(model_neuron, device_ids=[0, 1], dim=2) # Create a batched input # Note that image_batched.shape[dim] / len(device_ids) == image.shape[dim] batch_size = 2 * 8 image_batched = torch.rand([1, 3, batch_size, 8]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### Dynamic batching[#](#dynamic-batching "Permalink to this headline") In the following example, we use the [`torch_neuronx.DataParallel()`](#torch_neuronx.DataParallel "torch_neuronx.DataParallel") module to run inference using several different batch sizes without recompiling the Neuron model. ``` import torch import torch_neuronx from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module model_parallel = torch_neuronx.DataParallel(model_neuron) # Create batched inputs and run inference on the same model batch_sizes = [2, 3, 4, 5, 6] for batch_size in batch_sizes: image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### Dynamic batching disabled[#](#dynamic-batching-disabled "Permalink to this headline") In the following example, we use `torch_neuronx.DataParallel.disable_dynamic_batching()` to disable dynamic batching. We provide an example of a batch size that will not work when dynamic batching is disabled as well as an example of a batch size that does work when dynamic batching is disabled. ``` import torch import torch_neuronx from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module and use 2 NeuronCores model_parallel = torch_neuronx.DataParallel(model_neuron, device_ids=[0, 1], dim=0) # Disable dynamic batching model_parallel.disable_dynamic_batching() # Create a batched input (this won't work) batch_size = 4 image_batched = torch.rand([batch_size, 3, 224, 224]) # This will fail because dynamic batching is disabled and # image_batched.shape[dim] / len(device_ids) != image.shape[dim] # output = model_parallel(image_batched) # Create a batched input (this will work) batch_size = 2 image_batched = torch.rand([batch_size, 3, 224, 224]) # This will work because # image_batched.shape[dim] / len(device_ids) == image.shape[dim] output = model_parallel(image_batched) ``` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuronx) DataParallel API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Developer Guide (torch-neuronx)" href="../../programming-guide/inference/index.html"> <link rel="prev" title="PyTorch Neuron (torch-neuronx) Analyze API for Inference" href="api-torch-neuronx-analyze.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-usage"> Default usage </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#specifying-neuroncores"> Specifying NeuronCores </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-with-dim-0"> DataParallel with dim != 0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching-disabled"> Dynamic batching disabled </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuronx) DataParallel API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-usage"> Default usage </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#specifying-neuroncores"> Specifying NeuronCores </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-with-dim-0"> DataParallel with dim != 0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching-disabled"> Dynamic batching disabled </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-torch-neuronx-dataparallel-api"> <span id="torch-neuronx-dataparallel-api"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) DataParallel API<a class="headerlink" href="#pytorch-neuron-torch-neuronx-dataparallel-api" title="Permalink to this headline">#</a></h1> <p>The <a class="reference internal" href="#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> Python API implements data parallelism on <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> models created by <a class="reference internal" href="api-torch-neuronx-trace.html#torch-neuronx-trace-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Tracing API for Inference</span></a>. This function is analogous to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParallel</span></code></a> in PyTorch. The <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html#torch-neuronx-dataparallel-app-note"><span class="std std-ref">Data Parallel Inference on torch_neuronx</span></a> application note provides an overview of how <a class="reference internal" href="#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> can be used to improve the performance of inference workloads on Inferentia.</p> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.DataParallel"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.</span></span><span class="sig-name descname"><span class="pre">DataParallel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">set_dynamic_batching</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.DataParallel" title="Permalink to this definition">#</a></dt> <dd><p>Applies data parallelism by replicating the model on available NeuronCores and distributing data across the different NeuronCores for parallelized inference.</p> <p>By default, DataParallel will use all available NeuronCores allocated for the current process for parallelism. DataParallel will apply parallelism on <code class="docutils literal notranslate"><span class="pre">dim=0</span></code> if <code class="docutils literal notranslate"><span class="pre">dim</span></code> is not specified.</p> <p>DataParallel automatically enables <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html#dynamic-batching-description-torch-neuronx"><span class="std std-ref">dynamic batching</span></a> on eligible models if <code class="docutils literal notranslate"><span class="pre">dim=0</span></code>. Dynamic batching can be disabled using <code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel.disable_dynamic_batching()</span></code>, or by setting <code class="docutils literal notranslate"><span class="pre">set_dynamic_batching=False</span></code> when initializing the DataParallel object. If dynamic batching is not enabled, the batch size at compilation-time must be equal to the batch size at inference-time divided by the number of NeuronCores being used. Specifically, the following must be true when dynamic batching is disabled: <code class="docutils literal notranslate"><span class="pre">input.shape[dim]</span> <span class="pre">/</span> <span class="pre">len(device_ids)</span> <span class="pre">==</span> <span class="pre">compilation_input.shape[dim]</span></code>.</p> <p><a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> requires PyTorch &gt;= 1.8.</p> <p><em>Required Arguments</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>model</strong> (<a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>ScriptModule</em></a>) – Model created by the <a class="reference internal" href="api-torch-neuronx-trace.html#torch-neuronx-trace-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Tracing API for Inference</span></a> to be parallelized.</p> </dd> </dl> <p><em>Optional Arguments</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>device_ids</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><em>list</em></a>) – List of <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> or <code class="docutils literal notranslate"><span class="pre">'nc:#'</span></code> that specify the NeuronCores to use for parallelization (default: all NeuronCores). Refer to the <a class="reference internal" href="#device-ids-note-torch-neuronx"><span class="std std-ref">device_ids note</span></a> for a description of how <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> indexing works.</p></li> <li><p><strong>dim</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Dimension along which the input tensor is scattered across NeuronCores (default <code class="docutils literal notranslate"><span class="pre">dim=0</span></code>).</p></li> <li><p><strong>set_dynamic_batching</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – Whether to enable dynamic batching.</p></li> </ul> </dd> </dl> <p><em>Attributes</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>num_workers</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Number of worker threads used for multithreaded inference (default: <code class="docutils literal notranslate"><span class="pre">2</span> <span class="pre">*</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">NeuronCores</span></code>).</p></li> <li><p><strong>split_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Size of the input chunks (default: <code class="docutils literal notranslate"><span class="pre">max(1,</span> <span class="pre">input.shape[dim]</span> <span class="pre">//</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">NeuronCores)</span></code>).</p></li> </ul> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="torch.neuron.DataParallel.disable_dynamic_batching"> <span class="sig-prename descclassname"><span class="pre">torch.neuron.DataParallel.</span></span><span class="sig-name descname"><span class="pre">disable_dynamic_batching</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#torch.neuron.DataParallel.disable_dynamic_batching" title="Permalink to this definition">#</a></dt> <dd><p>Disables automatic dynamic batching on the DataParallel module. See <a class="reference internal" href="#dataparallel-example-disable-dynamic-batching-api-torch-neuronx"><span class="std std-ref">Dynamic batching disabled</span></a> for example of how DataParallel can be used with dynamic batching disabled. Use as follows:</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model_parallel</span><span class="o">.</span><span class="n">disable_dynamic_batching</span><span class="p">()</span> </pre></div> </div> </dd></dl> <div class="admonition note" id="device-ids-note-torch-neuronx"> <p class="admonition-title">Note</p> <p><code class="docutils literal notranslate"><span class="pre">device_ids</span></code> uses per-process NeuronCore granularity and zero-based indexing. Per-process granularity means that each Python process “sees” its own view of the world. Specifically, this means that <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> only “sees” the NeuronCores that are allocated for the current process. Zero-based indexing means that each Python process will index its allocated NeuronCores starting at 0, regardless of the “global” index of the NeuronCores. Zero-based indexing makes it possible to redeploy the exact same code unchanged in different process. This behavior is analogous to the <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument in the PyTorch <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParallel</span></code></a> function.</p> <p>As an example, assume DataParallel is run on an inf2.48xlarge, which contains 12 Inferentia chips each of which contains two NeuronCores:</p> <ul class="simple"> <li><p>If <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code> is not set, a single process can access all 24 NeuronCores. Thus specifying <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:0"]</span></code> will correspond to chip0:core0 and <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:13"]</span></code> will correspond to chip6:core1.</p></li> <li><p>However, if two processes are launched where: process 1 has <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES=0-11</span></code> and process 2 has <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES=12-23</span></code>, <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:13"]</span></code> cannot be specified in either process. Instead, chip6:core1 can only be accessed in process 2. Additionally, chip6:core1 is specified in process 2 with <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:1"]</span></code>. Furthermore, in process 1, <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:0"]</span></code> would correspond to chip0:core0; in process 2 <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:0"]</span></code> would correspond to chip6:core0.</p></li> </ul> </div> <div class="section" id="examples"> <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">#</a></h2> <p>The following sections provide example usages of the <a class="reference internal" href="#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> module.</p> <div class="section" id="default-usage"> <h3>Default usage<a class="headerlink" href="#default-usage" title="Permalink to this headline">#</a></h3> <p>The default DataParallel use mode will replicate the model on all available NeuronCores in the current process. The inputs will be split on <code class="docutils literal notranslate"><span class="pre">dim=0</span></code>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="c1"># Create a batched input</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">5</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="specifying-neuroncores"> <h3>Specifying NeuronCores<a class="headerlink" href="#specifying-neuroncores" title="Permalink to this headline">#</a></h3> <p>The following example uses the <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument to use the first three NeuronCores for DataParallel inference.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module, run on the first two NeuronCores</span> <span class="c1"># Equivalent to model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1])</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="s1">'nc:0'</span><span class="p">,</span> <span class="s1">'nc:1'</span><span class="p">])</span> <span class="c1"># Create a batched input</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">5</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dataparallel-with-dim-0"> <h3>DataParallel with dim != 0<a class="headerlink" href="#dataparallel-with-dim-0" title="Permalink to this headline">#</a></h3> <p>In this example we run DataParallel inference using two NeuronCores and <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">=</span> <span class="pre">2</span></code>. Because <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">!=</span> <span class="pre">0</span></code>, dynamic batching is not enabled. Consequently, the DataParallel inference-time batch size must be two times the compile-time batch size.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="c1"># Create an example model</span> <span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Model</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">8</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module using 2 NeuronCores and dim = 2</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="c1"># Create a batched input</span> <span class="c1"># Note that image_batched.shape[dim] / len(device_ids) == image.shape[dim]</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">2</span> <span class="o">*</span> <span class="mi">8</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="mi">8</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dynamic-batching"> <h3>Dynamic batching<a class="headerlink" href="#dynamic-batching" title="Permalink to this headline">#</a></h3> <p>In the following example, we use the <a class="reference internal" href="#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> module to run inference using several different batch sizes without recompiling the Neuron model.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="c1"># Create batched inputs and run inference on the same model</span> <span class="n">batch_sizes</span> <span class="o">=</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]</span> <span class="k">for</span> <span class="n">batch_size</span> <span class="ow">in</span> <span class="n">batch_sizes</span><span class="p">:</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dynamic-batching-disabled"> <span id="dataparallel-example-disable-dynamic-batching-api-torch-neuronx"></span><h3>Dynamic batching disabled<a class="headerlink" href="#dynamic-batching-disabled" title="Permalink to this headline">#</a></h3> <p>In the following example, we use <code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel.disable_dynamic_batching()</span></code> to disable dynamic batching. We provide an example of a batch size that will not work when dynamic batching is disabled as well as an example of a batch size that does work when dynamic batching is disabled.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module and use 2 NeuronCores</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># Disable dynamic batching</span> <span class="n">model_parallel</span><span class="o">.</span><span class="n">disable_dynamic_batching</span><span class="p">()</span> <span class="c1"># Create a batched input (this won't work)</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># This will fail because dynamic batching is disabled and</span> <span class="c1"># image_batched.shape[dim] / len(device_ids) != image.shape[dim]</span> <span class="c1"># output = model_parallel(image_batched)</span> <span class="c1"># Create a batched input (this will work)</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">2</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># This will work because</span> <span class="c1"># image_batched.shape[dim] / len(device_ids) == image.shape[dim]</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-torch-neuronx-analyze.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Analyze API for Inference</p> </div> </a> <a class="right-next" id="next-link" href="../../programming-guide/inference/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:50.813Z
Developer Guide (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/inference/index.html
# Developer Guide (torch-neuronx) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/programming-guide/inference/index.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/inference/index.rst) - [.rst](../../../../../_sources/frameworks/torch/torch-neuronx/programming-guide/inference/index.rst.txt) ## Developer Guide (torch-neuronx) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Developer Guide (`torch-neuronx`)[#](#developer-guide-torch-neuronx "Permalink to this headline") Developer Guide for Inference (`torch-neuronx`) - [NeuronCore Allocation and Model Placement for Inference (torch-neuronx)](core-placement.html#torch-neuronx-core-placement-guide) - [Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx)](trace-vs-xla-lazytensor.html#trace-vs-xla-lazytensor) - [Data Parallel Inference on torch\_neuronx](../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html#torch-neuronx-dataparallel-app-note) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Developer Guide (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="NeuronCore Allocation and Model Placement for Inference (torch-neuronx)" href="core-placement.html"> <link rel="prev" title="PyTorch Neuron (torch-neuronx) DataParallel API" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/programming-guide/inference/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/programming-guide/inference/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/inference/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/programming-guide/inference/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Developer Guide (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="developer-guide-torch-neuronx"> <h1>Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#developer-guide-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Developer Guide for Inference (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="core-placement.html#torch-neuronx-core-placement-guide"><span class="std std-ref">NeuronCore Allocation and Model Placement for Inference (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="trace-vs-xla-lazytensor.html#trace-vs-xla-lazytensor"><span class="std std-ref">Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html#torch-neuronx-dataparallel-app-note"><span class="std std-ref">Data Parallel Inference on torch_neuronx</span></a></p></li> </ul> </div> </details><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) DataParallel API</p> </div> </a> <a class="right-next" id="next-link" href="core-placement.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">NeuronCore Allocation and Model Placement for Inference (<span class="xref std std-ref">torch-neuronx</span>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:51.615Z
NeuronCore Allocation and Model Placement for Inference (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html
# NeuronCore Allocation and Model Placement for Inference (torch-neuronx) — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## [NeuronCore Allocation and Model Placement for Inference (](#id1)[torch-neuronx](../../../inference-torch-neuronx.html#inference-torch-neuronx))[#](#neuroncore-allocation-and-model-placement-for-inference-torch-neuronx "Permalink to this headline") This programming guide describes the how to allocate NeuronCores to processes and place models onto specific NeuronCores. The models in this guide are expected to have been traced with with [`torch_neuronx.trace()`](../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace"). In order of precedence, the recommendation is to use the following placement techniques: 1. For nearly all regular models, default core placement should be used to take control of all cores for a single process. 2. For applications using multiple processes, default core placement should be used in conjunction with `NEURON_RT_NUM_CORES` ([Default Core Allocation & Placement](#torch-neuronx-placement-default)) 3. For more granular control, then the experimental explicit placement APIs may be used ([Experimental: Explicit Core Placement](#torch-neuronx-placement-explicit)). Table of Contents - [NeuronCore Allocation and Model Placement for Inference (](#neuroncore-allocation-and-model-placement-for-inference-torch-neuronx)[torch-neuronx](../../../inference-torch-neuronx.html#inference-torch-neuronx)) - [Default Core Allocation & Placement](#default-core-allocation-placement) - [Example: Default](#example-default) - [Example: `NEURON_RT_NUM_CORES`](#example-neuron-rt-num-cores) - [Example: `NEURON_RT_VISIBLE_CORES`](#example-neuron-rt-visible-cores) - [Example: Multiple Processes](#example-multiple-processes) - [Experimental: Explicit Core Placement](#experimental-explicit-core-placement) - [Example: Manual Core Selection](#example-manual-core-selection) - [Example: Automatic Multicore](#example-automatic-multicore) The following guide will assume a machine with 8 NeuronCores: - NeuronCores will use the notation `nc0`, `nc1`, etc. - Models will use the notation `m0`, `m1` etc. NeuronCores and model allocations will be displayed in the following format: Process Allocated NeuronCores Models nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 NeuronCores The actual cores that are visible to the process can be adjusted according to the [Neuron Runtime Configuration](../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration). Unlike [torch-neuron](../../../inference-torch-neuron.html#inference-torch-neuron) (with [neuron-cc](../../../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference)) instances, [torch-neuronx](../../../inference-torch-neuronx.html#inference-torch-neuronx) (with [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide)) does not support [NeuronCore Pipeline](../../../../../general/arch/neuron-features/neuroncore-pipeline.html#neuroncore-pipeline). This simplifies model core allocations since it means that model pipelines will likely not span across multiple NeuronCores. ## [Default Core Allocation & Placement](#id2)[#](#default-core-allocation-placement "Permalink to this headline") The most basic requirement of an inference application is to be able to place a single model on a single NeuronCore. More complex applications may use multiple NeuronCores or even multiple processes each executing different models. The important thing to note about designing an inference application is that a single NeuronCore will always be allocated to a single process. _Processes do not share NeuronCores_. Different configurations can be used to ensure that an application process has enough NeuronCores allocated to execute its model(s): - Default: A process will attempt to take ownership of **all NeuronCores** visible on the instance. This should be used when an instance is only running a single inference process since no other process will be allowed to take ownership of any NeuronCores. - `NEURON_RT_NUM_CORES`: Specify the **number of NeuronCores** to allocate to the process. This places no restrictions on which NeuronCores will be used, however, the resulting NeuronCores will always be contiguous. This should be used in multi-process applications where each process should only use a subset of NeuronCores. - `NEURON_RT_VISIBLE_CORES`: Specifies exactly **which NeuronCores** are allocated to the process by index. Similar to `NEURON_RT_NUM_CORES`, this can be used in multi-process applications where each process should only use a subset of NeuronCores. This provides more fined-grained controls over the exact NeuronCores that are allocated to a given process. See the [Neuron Runtime Configuration](../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration) for more environment variable details. ### [Example: Default](#id3)[#](#example-default "Permalink to this headline") **Python Script**: ``` import torch import torch_neuronx m0 = torch.jit.load('model.pt') # Loads to nc0 m1 = torch.jit.load('model.pt') # Loads to nc1 ``` allocated m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 With no environment configuration, the process will take ownership of all NeuronCores. In this example, only two of the NeuronCores are used by the process and the remaining are allocated but left idle. ### [Example: `NEURON_RT_NUM_CORES`](#id4)[#](#example-neuron-rt-num-cores "Permalink to this headline") **Environment Setup**: ``` export NEURON_RT_NUM_CORES = '2' ``` **Python Script**: ``` import torch import torch_neuronx m0 = torch.jit.load('model.pt') # Loads to nc0 m1 = torch.jit.load('model.pt') # Loads to nc1 ``` allocated unallocated m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 Since there is no other process on the instance, only the first 2 NeuronCores will be acquired by the process. Models load in a simple linear order to the least used NeuronCores. ### [Example: `NEURON_RT_VISIBLE_CORES`](#id5)[#](#example-neuron-rt-visible-cores "Permalink to this headline") **Environment Setup**: ``` export NEURON_RT_VISIBLE_CORES = '4-5' ``` **Python Script**: ``` import torch import torch_neuronx m0 = torch.jit.load('model.pt') # Loads to nc4 m1 = torch.jit.load('model.pt') # Loads to nc5 ``` allocated unallocated unallocated m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 Unlike `NEURON_RT_NUM_CORES`, setting the visible NeuronCores allows the process to take control of a specific contiguous set. This allows an application to have a more fine-grained control of where models will be placed. ### [Example: Multiple Processes](#id6)[#](#example-multiple-processes "Permalink to this headline") **Environment Setup**: ``` export NEURON_RT_NUM_CORES = '2' ``` **Python Script**: ``` import torch import torch_neuronx m0 = torch.jit.load('model.pt') # Loads to nc0 m1 = torch.jit.load('model.pt') # Loads to nc1 ``` In this example, if the script is run **twice**, the following allocations will be made: proc0 proc1 unallocated m0 m1 m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 Note that each process will take ownership of as many NeuronCores as is specified by the `NEURON_RT_NUM_CORES` configuration. ## [Experimental: Explicit Core Placement](#id7)[#](#experimental-explicit-core-placement "Permalink to this headline") The `torch_neuronx` framework allows can be found in the [PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs \[Experimental\]](../../api-reference-guide/inference/api-torch-neuronx-core-placement.html#torch-neuronx-core-placement-api) documentation. ### [Example: Manual Core Selection](#id8)[#](#example-manual-core-selection "Permalink to this headline") The most direct usage of the placement APIs is to manually select the start NeuronCore that each model is loaded to. **Environment Setup**: ``` export NEURON_RT_NUM_CORES = '4' ``` **Python Script**: ``` import torch import torch_neuronx # NOTE: Order of loads does NOT matter with torch_neuronx.experimental.neuron_cores_context(start_nc=3): m0 = torch.jit.load('model.pt') # Loads to nc3 with torch_neuronx.experimental.neuron_cores_context(start_nc=0, nc_count=2): m1 = torch.jit.load('model.pt') # Loads replicas to nc0 and nc1 example = torch.rand(1, 3, 224, 224) m1(example) # Executes on nc3 m1(example) # Executes on nc3 m0(example) # Executes on nc0 m0(example) # Executes on nc1 m0(example) # Executes on nc0 ``` allocated unallocated m1 m1 m0 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 ### [Example: Automatic Multicore](#id9)[#](#example-automatic-multicore "Permalink to this headline") Using explicit core placement it is possible to replicate a model to multiple NeuronCores simultaneously. This means that a single model object within python can utilize all available NeuronCores (or NeuronCores allocated to the process). **Environment Setup**: ``` export NEURON_RT_NUM_CORES = '8' ``` **Python Script**: ``` import torch import torch_neuronx with torch_neuronx.experimental.multicore_context(): m0 = torch.jit.load('model.pt') # Loads replications to nc0-nc7 example = torch.rand(1, 3, 224, 224) m0(example) # Executes on nc0 m0(example) # Executes on nc1 ``` allocated m0 m0 m0 m0 m0 m0 m0 m0 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 To make full use of a model that has been loaded to multiple NeuronCores, multiple threads should be used to run inferences in parallel. _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>NeuronCore Allocation and Model Placement for Inference (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx)" href="trace-vs-xla-lazytensor.html"> <link rel="prev" title="Developer Guide (torch-neuronx)" href="index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/programming-guide/inference/core-placement", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="index.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/programming-guide/inference/core-placement.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-core-allocation-placement"> Default Core Allocation &amp; Placement </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-default"> Example: Default </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-neuron-rt-num-cores"> Example: <code class="docutils literal notranslate"> <span class="pre"> NEURON_RT_NUM_CORES </span> </code> </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-neuron-rt-visible-cores"> Example: <code class="docutils literal notranslate"> <span class="pre"> NEURON_RT_VISIBLE_CORES </span> </code> </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-multiple-processes"> Example: Multiple Processes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#experimental-explicit-core-placement"> Experimental: Explicit Core Placement </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-manual-core-selection"> Example: Manual Core Selection </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-automatic-multicore"> Example: Automatic Multicore </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>NeuronCore Allocation and Model Placement for Inference (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-core-allocation-placement"> Default Core Allocation &amp; Placement </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-default"> Example: Default </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-neuron-rt-num-cores"> Example: <code class="docutils literal notranslate"> <span class="pre"> NEURON_RT_NUM_CORES </span> </code> </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-neuron-rt-visible-cores"> Example: <code class="docutils literal notranslate"> <span class="pre"> NEURON_RT_VISIBLE_CORES </span> </code> </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-multiple-processes"> Example: Multiple Processes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#experimental-explicit-core-placement"> Experimental: Explicit Core Placement </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-manual-core-selection"> Example: Manual Core Selection </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-automatic-multicore"> Example: Automatic Multicore </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="neuroncore-allocation-and-model-placement-for-inference-torch-neuronx"> <span id="torch-neuronx-core-placement-guide"></span><h1><a class="toc-backref" href="#id1">NeuronCore Allocation and Model Placement for Inference (</a><a class="reference internal" href="../../../inference-torch-neuronx.html#inference-torch-neuronx"><span class="std std-ref">torch-neuronx</span></a>)<a class="headerlink" href="#neuroncore-allocation-and-model-placement-for-inference-torch-neuronx" title="Permalink to this headline">#</a></h1> <p>This programming guide describes the how to allocate NeuronCores to processes and place models onto specific NeuronCores. The models in this guide are expected to have been traced with with <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>.</p> <div class="admonition warning"> <p class="admonition-title">Warning</p> <p>This guide is <strong>not</strong> applicable to NeuronCore placement using XLA LazyTensor device execution. See: <a class="reference internal" href="trace-vs-xla-lazytensor.html#trace-vs-xla-lazytensor"><span class="std std-ref">Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx)</span></a></p> </div> <p>In order of precedence, the recommendation is to use the following placement techniques:</p> <ol class="arabic simple"> <li><p>For nearly all regular models, default core placement should be used to take control of all cores for a single process.</p></li> <li><p>For applications using multiple processes, default core placement should be used in conjunction with <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code> (<a class="reference internal" href="#torch-neuronx-placement-default"><span class="std std-ref">Default Core Allocation &amp; Placement</span></a>)</p></li> <li><p>For more granular control, then the experimental explicit placement APIs may be used (<a class="reference internal" href="#torch-neuronx-placement-explicit"><span class="std std-ref">Experimental: Explicit Core Placement</span></a>).</p></li> </ol> <div class="contents topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#neuroncore-allocation-and-model-placement-for-inference-torch-neuronx" id="id1">NeuronCore Allocation and Model Placement for Inference (</a><a class="reference internal" href="../../../inference-torch-neuronx.html#inference-torch-neuronx"><span class="std std-ref">torch-neuronx</span></a>)</p> <ul> <li><p><a class="reference internal" href="#default-core-allocation-placement" id="id2">Default Core Allocation &amp; Placement</a></p> <ul> <li><p><a class="reference internal" href="#example-default" id="id3">Example: Default</a></p></li> <li><p><a class="reference internal" href="#example-neuron-rt-num-cores" id="id4">Example: <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code></a></p></li> <li><p><a class="reference internal" href="#example-neuron-rt-visible-cores" id="id5">Example: <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code></a></p></li> <li><p><a class="reference internal" href="#example-multiple-processes" id="id6">Example: Multiple Processes</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#experimental-explicit-core-placement" id="id7">Experimental: Explicit Core Placement</a></p> <ul> <li><p><a class="reference internal" href="#example-manual-core-selection" id="id8">Example: Manual Core Selection</a></p></li> <li><p><a class="reference internal" href="#example-automatic-multicore" id="id9">Example: Automatic Multicore</a></p></li> </ul> </li> </ul> </li> </ul> </div> <p>The following guide will assume a machine with 8 NeuronCores:</p> <ul class="simple"> <li><p>NeuronCores will use the notation <code class="docutils literal notranslate"><span class="pre">nc0</span></code>, <code class="docutils literal notranslate"><span class="pre">nc1</span></code>, etc.</p></li> <li><p>Models will use the notation <code class="docutils literal notranslate"><span class="pre">m0</span></code>, <code class="docutils literal notranslate"><span class="pre">m1</span></code> etc.</p></li> </ul> <p>NeuronCores and model allocations will be displayed in the following format:</p> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="1px" y="68%" height="31%" width="97.5%" rx="5" opacity="100%" fill="none" stroke="black" stroke-width="1px" stroke-dasharray="6"> <animate attributeName="stroke-dashoffset" values="12px;0px" dur="0.2s" calcMode="linear" repeatCount="indefinite"></animate> </rect> <text x="50%" y="82.5%" class="label" style="fill:black">Process Allocated NeuronCores</text> <!-- Models --> <rect x="1px" y="1px" height="31%" width="97.5%" rx="5" opacity="100%" fill="None" stroke="black" stroke-width="1px" stroke-dasharray="6"> <animate attributeName="stroke-dashoffset" values="12px;0px" dur="0.2s" calcMode="linear" repeatCount="indefinite"></animate> </rect> <text x="50.0%" y="16.66%" class="label" style="fill:black">Models</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> <linearGradient id="lgrad" x1="100%" y1="50%" x2="0%" y2="50%"> <stop offset="0" stop-color="white"></stop> <stop offset="0.3" stop-color="black"></stop> <stop offset="0.7" stop-color="black"></stop> <stop offset="1" stop-color="white"></stop> </linearGradient> <mask id="myMask" x="0" y="0" width="100%" height="100%"> <rect x="0" y="0" width="100%" height="100%" fill="url(#lgrad)"></rect> </mask> </defs> <g mask="url(#myMask)"> <g fill="gray"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </g> <text x="50%" y="50%" class="label" style="fill:black">NeuronCores</text> </svg> <p>The actual cores that are visible to the process can be adjusted according to the <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration"><span class="std std-ref">Neuron Runtime Configuration</span></a>.</p> <p>Unlike <a class="reference internal" href="../../../inference-torch-neuron.html#inference-torch-neuron"><span class="std std-ref">torch-neuron</span></a> (with <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference"><span class="std std-ref">neuron-cc</span></a>) instances, <a class="reference internal" href="../../../inference-torch-neuronx.html#inference-torch-neuronx"><span class="std std-ref">torch-neuronx</span></a> (with <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a>) does not support <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html#neuroncore-pipeline"><span class="std std-ref">NeuronCore Pipeline</span></a>. This simplifies model core allocations since it means that model pipelines will likely not span across multiple NeuronCores.</p> <div class="section" id="default-core-allocation-placement"> <span id="torch-neuronx-placement-default"></span><h2><a class="toc-backref" href="#id2">Default Core Allocation &amp; Placement</a><a class="headerlink" href="#default-core-allocation-placement" title="Permalink to this headline">#</a></h2> <p>The most basic requirement of an inference application is to be able to place a single model on a single NeuronCore. More complex applications may use multiple NeuronCores or even multiple processes each executing different models. The important thing to note about designing an inference application is that a single NeuronCore will always be allocated to a single process. <em>Processes do not share NeuronCores</em>. Different configurations can be used to ensure that an application process has enough NeuronCores allocated to execute its model(s):</p> <ul class="simple"> <li><p>Default: A process will attempt to take ownership of <strong>all NeuronCores</strong> visible on the instance. This should be used when an instance is only running a single inference process since no other process will be allowed to take ownership of any NeuronCores.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code>: Specify the <strong>number of NeuronCores</strong> to allocate to the process. This places no restrictions on which NeuronCores will be used, however, the resulting NeuronCores will always be contiguous. This should be used in multi-process applications where each process should only use a subset of NeuronCores.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code>: Specifies exactly <strong>which NeuronCores</strong> are allocated to the process by index. Similar to <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code>, this can be used in multi-process applications where each process should only use a subset of NeuronCores. This provides more fined-grained controls over the exact NeuronCores that are allocated to a given process.</p></li> </ul> <p>See the <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration"><span class="std std-ref">Neuron Runtime Configuration</span></a> for more environment variable details.</p> <div class="section" id="example-default"> <h3><a class="toc-backref" href="#id3">Example: Default</a><a class="headerlink" href="#example-default" title="Permalink to this headline">#</a></h3> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc1</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="97.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="50%" y="82.5%" class="label" style="fill:black">allocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" width="10%" height="31%" rx="20"></rect> <rect x="12.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>With no environment configuration, the process will take ownership of all NeuronCores. In this example, only two of the NeuronCores are used by the process and the remaining are allocated but left idle.</p> </div> <div class="section" id="example-neuron-rt-num-cores"> <h3><a class="toc-backref" href="#id4">Example: <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code></a><a class="headerlink" href="#example-neuron-rt-num-cores" title="Permalink to this headline">#</a></h3> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_NUM_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'2'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc1</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } .small { font-family: Consolas, monaco, monospace; font-size: 1.5vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="11.25%" y="82.5%" class="small" style="fill:black">allocated</text> <rect x="25.0%" y="33%" height="66.6%" width="75%" rx="20" opacity="20%" fill="gray"></rect> <text x="61.5%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" width="10%" height="31%" rx="20"></rect> <rect x="12.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> </g> <g fill="gray"> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>Since there is no other process on the instance, only the first 2 NeuronCores will be acquired by the process. Models load in a simple linear order to the least used NeuronCores.</p> </div> <div class="section" id="example-neuron-rt-visible-cores"> <h3><a class="toc-backref" href="#id5">Example: <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code></a><a class="headerlink" href="#example-neuron-rt-visible-cores" title="Permalink to this headline">#</a></h3> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_VISIBLE_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'4-5'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc4</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc5</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } .small { font-family: Consolas, monaco, monospace; font-size: 1.5vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="50%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="61.25%" y="82.5%" class="small" style="fill:black">allocated</text> <rect x="0.0%" y="33%" height="66.6%" width="47.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="23.75%" y="82.5%" class="label" style="fill:black">unallocated</text> <rect x="75%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="86.25%" y="82.5%" class="label" style="fill:black;font-size: 1.5vw">unallocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="50.0%" width="10%" height="31%" rx="20"></rect> <rect x="62.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="55.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="67.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> </g> <g fill="gray"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>Unlike <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code>, setting the visible NeuronCores allows the process to take control of a specific contiguous set. This allows an application to have a more fine-grained control of where models will be placed.</p> </div> <div class="section" id="example-multiple-processes"> <h3><a class="toc-backref" href="#id6">Example: Multiple Processes</a><a class="headerlink" href="#example-multiple-processes" title="Permalink to this headline">#</a></h3> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_NUM_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'2'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc1</span> </pre></div> </div> <p>In this example, if the script is run <strong>twice</strong>, the following allocations will be made:</p> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33.0%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="11.5%" y="82.5%" class="label" style="fill:black">proc0</text> <rect x="25.0%" y="33.0%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="violet"></rect> <text x="36.5%" y="82.5%" class="label" style="fill:black">proc1</text> <rect x="50.0%" y="33.3%" height="66.6%" width="47.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="74.0%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" width="10%" height="31%" rx="20"></rect> <rect x="12.5%" width="10%" height="31%" rx="20"></rect> <rect x="25.0%" width="10%" height="31%" rx="20"></rect> <rect x="37.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m1</text> <text x="30.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="42.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> </g> <g fill="violet"> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> </g> <g fill="gray"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>Note that each process will take ownership of as many NeuronCores as is specified by the <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code> configuration.</p> </div> </div> <div class="section" id="experimental-explicit-core-placement"> <span id="torch-neuronx-placement-explicit"></span><h2><a class="toc-backref" href="#id7">Experimental: Explicit Core Placement</a><a class="headerlink" href="#experimental-explicit-core-placement" title="Permalink to this headline">#</a></h2> <p>The <code class="docutils literal notranslate"><span class="pre">torch_neuronx</span></code> framework allows can be found in the <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html#torch-neuronx-core-placement-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) NeuronCore Placement APIs [Experimental]</span></a> documentation.</p> <div class="section" id="example-manual-core-selection"> <h3><a class="toc-backref" href="#id8">Example: Manual Core Selection</a><a class="headerlink" href="#example-manual-core-selection" title="Permalink to this headline">#</a></h3> <p>The most direct usage of the placement APIs is to manually select the start NeuronCore that each model is loaded to.</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_NUM_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'4'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="c1"># NOTE: Order of loads does NOT matter</span> <span class="k">with</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">3</span><span class="p">):</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc3</span> <span class="k">with</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads replicas to nc0 and nc1</span> <span class="n">example</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">)</span> <span class="n">m1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on nc3</span> <span class="n">m1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on nc3</span> <span class="n">m0</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on nc0</span> <span class="n">m0</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on nc1</span> <span class="n">m0</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on nc0</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="47.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="23.5%" y="82.5%" class="label" style="fill:black">allocated</text> <rect x="50.0%" y="33%" height="66.6%" width="47.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="74.0%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <g opacity="40%" fill="orange"> <rect x="00.0%" width="10%" height="31%" rx="20"> </rect> <rect x="12.5%" width="10%" height="31%" rx="20"> </rect> <rect x="37.5%" width="10%" height="31%" rx="20"> </rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m1 </text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m1 </text> <text x="42.5%" y="16.66%" class="label" style="fill:black">m0 </text> <!-- <text x="11.5%" y="16.66%" class="label" style="fill:black">m1--> <!-- <animate attributeName="opacity" values="1;0;0;0;1;1;1" dur="5s" repeatCount="indefinite" />--> <!-- </text>--> <!-- <text x="36.5%" y="16.66%" class="label" style="fill:black">m1--> <!-- <animate attributeName="opacity" values="1;0;1;1;1;1;1" dur="5s" repeatCount="indefinite" />--> <!-- </text>--> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> </g> <g fill="gray"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg></div> <div class="section" id="example-automatic-multicore"> <h3><a class="toc-backref" href="#id9">Example: Automatic Multicore</a><a class="headerlink" href="#example-automatic-multicore" title="Permalink to this headline">#</a></h3> <p>Using explicit core placement it is possible to replicate a model to multiple NeuronCores simultaneously. This means that a single model object within python can utilize all available NeuronCores (or NeuronCores allocated to the process).</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_NUM_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'8'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="k">with</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">multicore_context</span><span class="p">():</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> <span class="c1"># Loads replications to nc0-nc7</span> <span class="n">example</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">)</span> <span class="n">m0</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on nc0</span> <span class="n">m0</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on nc1</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="97.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="50%" y="82.5%" class="label" style="fill:black">allocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" width="10%" height="31%" rx="20"></rect> <rect x="12.5%" width="10%" height="31%" rx="20"></rect> <rect x="25.0%" width="10%" height="31%" rx="20"></rect> <rect x="37.5%" width="10%" height="31%" rx="20"></rect> <rect x="50.0%" width="10%" height="31%" rx="20"></rect> <rect x="62.5%" width="10%" height="31%" rx="20"></rect> <rect x="75.0%" width="10%" height="31%" rx="20"></rect> <rect x="87.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m0</text> <text x="30.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="42.5%" y="16.66%" class="label" style="fill:black">m0</text> <text x="55.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="67.5%" y="16.66%" class="label" style="fill:black">m0</text> <text x="80.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="92.5%" y="16.66%" class="label" style="fill:black">m0</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>To make full use of a model that has been loaded to multiple NeuronCores, multiple threads should be used to run inferences in parallel.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="trace-vs-xla-lazytensor.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Comparison of Traced Inference versus XLA <span class="xref std std-ref">Lazy Tensor</span> Inference (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:51.958Z
Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html
# Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx) — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Comparison of Traced Inference versus XLA [Lazy Tensor](#xla-lazytensor) Inference (`torch-neuronx`)[#](#comparison-of-traced-inference-versus-xla-lazytensor-inference-torch-neuronx "Permalink to this headline") Table of contents - [Introduction](#introduction) - [XLA Lazy Tensor Inference Mechanics](#xla-lazy-tensor-inference-mechanics) - [Traced Inference Mechanics](#traced-inference-mechanics) - [Traced Inference Advantages](#traced-inference-advantages) - [Summary](#summary) ## [Introduction](#id2)[#](#introduction "Permalink to this headline") Using `torch-neuronx`, there are two ways that a model can be executed for inference: - **XLA LazyTensor Inference**: A model is executed on Neuron by calling [`to()`](https://pytorch.org/docs/master/generated/torch.Tensor.to.html#torch.Tensor.to "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to move [`Parameter`](https://pytorch.org/docs/master/generated/torch.nn.parameter.Parameter.html#torch.nn.parameter.Parameter "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") and [`Tensor`](https://pytorch.org/docs/master/tensors.html#torch.Tensor "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") data using the `xm.xla_device()`. Executing operations uses torch [Lazy Tensor](#xla-lazytensor) to record, compile, and execute the graph. These are the same mechanisms used for [training](../training/pytorch-neuron-programming-guide.html#pytorch-neuronx-programming-guide). - **(Recommended) Traced Inference**: A model is traced prior to inference using the [`trace()`](../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") API. This trace is similar to [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") but instead creates a Neuron-specific [TorchScript](https://pytorch.org/docs/stable/jit.html) artifact. This artifact provides improved performance and portability compared to XLA [Lazy Tensor](#xla-lazytensor) inference. ## [XLA Lazy Tensor Inference Mechanics](#id3)[#](#xla-lazy-tensor-inference-mechanics "Permalink to this headline") XLA [Lazy Tensor](#xla-lazytensor) inference uses Just-In-Time (JIT) compilation for Neuron execution. XLA Device execution uses the built-in `torch-xla` functionality with torch [Lazy Tensor](#xla-lazytensor) to record torch operations using the `xm.xla_device()`. The graph of operations is sent to the [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) compiler upon calling `xm.mark_step()`. Finally the compiled graph is transferred to a NeuronCore and executed in the Neuron backend. The initial model inference will be very slow since the model binary file in the Neuron Executable File Format (NEFF) will need to be generated by the compiler. Upon each subsequent call to a model, the application will re-execute the python, rebuild the graph, and check a cache to see if an existing NEFF file is available for the given graph before attempting to recompile. The process of recording graph operations in python can become a bottleneck for otherwise fast models. This overhead will always have an effect on performance regardless of model size but may be less noticeable on larger models. Note that this XLA [Lazy Tensor](#xla-lazytensor) execution performance may improve significantly with new torch features in the future. ### Example[#](#example "Permalink to this headline") Fixed Shape Example ``` import torch import torch_neuronx import torch_xla.core.xla_model as xm # Create XLA device device = xm.xla_device() # Load example model and inputs to Neuron device model = torch.nn.Sequential( torch.nn.Linear(784, 120), torch.nn.ReLU(), torch.nn.Linear(120, 10), torch.nn.Softmax(dim=-1), ) model.eval() model.to(device) example = torch.rand((1, 784), device=device) # Inference with torch.no_grad(): result = model(example) xm.mark_step() # Compilation occurs here print(result.cpu()) ``` Dynamic Shape Example The following is an example of a model that dynamically changes the sequence length and batch size of the input token ID tensor to trigger recompilations. This kind of workflow would require padding when using traced inference. ``` import torch import torch_neuronx import torch_xla.core.xla_model as xm # Create XLA device device = xm.xla_device() # Load example model and inputs to Neuron device model = torch.nn.Sequential( torch.nn.Embedding(num_embeddings=30522, embedding_dim=512), torch.nn.Linear(512, 128), torch.nn.ReLU(), torch.nn.Linear(128, 2), torch.nn.Softmax(dim=-1), ) model.eval() model.to(device) token_ids_1 = torch.tensor([ [1, 28, 748, 0], ]) # shape: [1, 4] token_ids_2 = torch.tensor([ [1, 13087, 10439, 1990, 18912, 0], [1, 12009, 7849, 2509, 3500, 0], ]) # shape: [2, 6] # Inference with torch.no_grad(): # First compilation/inference result = model(token_ids_1) xm.mark_step() print(result.cpu()) # shape: [1, 4, 2] # Recompilation occurs here since token_ids_2 is a different shape. This infer # would have failed if the model had been traced with shape [1, 4] result = model(token_ids_2) xm.mark_step() print(result.cpu()) # shape: [2, 6, 2] ``` ## [Traced Inference Mechanics](#id4)[#](#traced-inference-mechanics "Permalink to this headline") Traced inference uses Ahead-Of-Time (AOT) compilation for Neuron execution. Similar to XLA [Lazy Tensor](#xla-lazytensor) inference, [`trace()`](../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") uses the operation recording mechanisms provided by `torch-xla` to build the graph structure. This graph structure is also sent to the [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) compiler to produce a binary (NEFF) that is executable on Neuron. The main difference is that the call to [`trace()`](../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") returns a _new_ fully compiled graph as a [TorchScript](https://pytorch.org/docs/stable/jit.html) Module. Upon calling this new Module, rather than re-executing the python, rebuilding the graph, and checking the cache for a matching model, the new Module simply executes the precompiled graph that was preloaded during tracing. This is a significantly more optimized runtime since it avoids the python operator tracing, graph building, etc. One disadvantage of this interface is that a model will never dynamically recompile after a trace. This means that dynamic control flow is not supported within a function/module. Tensor input/output shapes are fixed to the shapes passed to the [`trace()`](../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") API. Dynamic batching and bucketing can be used to avoid the pitfalls of static shapes. ### Example[#](#id1 "Permalink to this headline") ``` import torch import torch_neuronx # Create example model and inputs model = torch.nn.Sequential( torch.nn.Linear(784, 120), torch.nn.ReLU(), torch.nn.Linear(120, 10), torch.nn.Softmax(dim=-1), ) model.eval() example = torch.rand((1, 784)) # Create fixed model trace trace = torch_neuronx.trace(model, example) # Inference result = trace(example) # No recompilation. Input shapes must not change print(result) ``` ## [Traced Inference Advantages](#id5)[#](#traced-inference-advantages "Permalink to this headline") Traced inference should be used for nearly all deployment purposes since it provides some key advantages over XLA [Lazy Tensor](#xla-lazytensor) execution: - **Reduced Overhead**: There is no overhead associated with graph recording, compilation, and model loading since these steps are performed only once within the call to [`trace()`](../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace"). In contrast, when using XLA [Lazy Tensor](#xla-lazytensor) inference, all of these steps are performed just-in-time (with caching to improve performance). - **Serializable**: The TorchScript Module that is produced from the [`trace()`](../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") API is serializable using the normal [`torch.jit.save()`](https://pytorch.org/docs/master/generated/torch.jit.save.html#torch.jit.save "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function. It is able to be reloaded in an inference environment with [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). In contrast, XLA device inference does not provide a predetermined serialization format that includes the pre-compiled NEFF artifacts. These must be manually copied to an inference environment to be used. - **Reduced Dependencies**: When using the traced TorchScript Module in an inference environment, it is no longer required to install the [neuronx-cc](../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) compiler. In contrast, when using the XLA [Lazy Tensor](#xla-lazytensor) execution, an execution may require a recompile to successfully infer. - **Static & Predictable**: The resulting module produced by [`trace()`](../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") will contain a static model that will consume a predictable amount of Neuron device memory and will never require recompilation based on input changes. In contrast, since XLA device inference performs just-in-time compilation, it can be more difficult to predict memory utilization and the compilations that may be required at inference time. - **C++ Usability**: If the end application is an inference platform using `libtorch`, it is easy to integrate with `libtorchneuron` to load traced modules. It is not currently possible to set up an environment to use torch in C++ in conjunction with Neuron XLA [Lazy Tensor](#xla-lazytensor) execution. ## [Summary](#id6)[#](#summary "Permalink to this headline") | | XLA Device Inference | Traced Inference | | --- | --- | --- | | Compilation | JIT | AOT | | Serialization | N/A | [TorchScript](https://pytorch.org/docs/stable/jit.html) | | Performance | Slower | Faster | | Dynamic | Yes | No | | C++ Usage | No | Yes | _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Data Parallel Inference on torch_neuronx" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> <link rel="prev" title="NeuronCore Allocation and Model Placement for Inference (torch-neuronx)" href="core-placement.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="index.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#xla-lazy-tensor-inference-mechanics"> XLA Lazy Tensor Inference Mechanics </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example"> Example </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#traced-inference-mechanics"> Traced Inference Mechanics </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Example </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#traced-inference-advantages"> Traced Inference Advantages </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary"> Summary </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#xla-lazy-tensor-inference-mechanics"> XLA Lazy Tensor Inference Mechanics </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example"> Example </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#traced-inference-mechanics"> Traced Inference Mechanics </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Example </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#traced-inference-advantages"> Traced Inference Advantages </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary"> Summary </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="comparison-of-traced-inference-versus-xla-lazytensor-inference-torch-neuronx"> <span id="trace-vs-xla-lazytensor"></span><h1>Comparison of Traced Inference versus XLA <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> Inference (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#comparison-of-traced-inference-versus-xla-lazytensor-inference-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#introduction" id="id2">Introduction</a></p></li> <li><p><a class="reference internal" href="#xla-lazy-tensor-inference-mechanics" id="id3">XLA Lazy Tensor Inference Mechanics</a></p></li> <li><p><a class="reference internal" href="#traced-inference-mechanics" id="id4">Traced Inference Mechanics</a></p></li> <li><p><a class="reference internal" href="#traced-inference-advantages" id="id5">Traced Inference Advantages</a></p></li> <li><p><a class="reference internal" href="#summary" id="id6">Summary</a></p></li> </ul> </div> <div class="section" id="introduction"> <h2><a class="toc-backref" href="#id2">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">#</a></h2> <p>Using <code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>, there are two ways that a model can be executed for inference:</p> <ul class="simple"> <li><p><strong>XLA LazyTensor Inference</strong>: A model is executed on Neuron by calling <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.Tensor.to.html#torch.Tensor.to" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-meth docutils literal notranslate"><span class="pre">to()</span></code></a> to move <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.parameter.Parameter.html#torch.nn.parameter.Parameter" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parameter</span></code></a> and <a class="reference external" href="https://pytorch.org/docs/master/tensors.html#torch.Tensor" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a> data using the <code class="code docutils literal notranslate"><span class="pre">xm.xla_device()</span></code>. Executing operations uses torch <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> to record, compile, and execute the graph. These are the same mechanisms used for <a class="reference internal" href="../training/pytorch-neuron-programming-guide.html#pytorch-neuronx-programming-guide"><span class="std std-ref">training</span></a>.</p></li> <li><p><strong>(Recommended) Traced Inference</strong>: A model is traced prior to inference using the <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">trace()</span></code></a> API. This trace is similar to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a> but instead creates a Neuron-specific <a class="reference external" href="https://pytorch.org/docs/stable/jit.html">TorchScript</a> artifact. This artifact provides improved performance and portability compared to XLA <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> inference.</p></li> </ul> </div> <div class="section" id="xla-lazy-tensor-inference-mechanics"> <span id="xla-lazytensor"></span><h2><a class="toc-backref" href="#id3">XLA Lazy Tensor Inference Mechanics</a><a class="headerlink" href="#xla-lazy-tensor-inference-mechanics" title="Permalink to this headline">#</a></h2> <p>XLA <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> inference uses Just-In-Time (JIT) compilation for Neuron execution.</p> <p>XLA Device execution uses the built-in <code class="docutils literal notranslate"><span class="pre">torch-xla</span></code> functionality with torch <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> to record torch operations using the <code class="code docutils literal notranslate"><span class="pre">xm.xla_device()</span></code>. The graph of operations is sent to the <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a> compiler upon calling <code class="docutils literal notranslate"><span class="pre">xm.mark_step()</span></code>. Finally the compiled graph is transferred to a NeuronCore and executed in the Neuron backend.</p> <p>The initial model inference will be very slow since the model binary file in the Neuron Executable File Format (NEFF) will need to be generated by the compiler. Upon each subsequent call to a model, the application will re-execute the python, rebuild the graph, and check a cache to see if an existing NEFF file is available for the given graph before attempting to recompile.</p> <p>The process of recording graph operations in python can become a bottleneck for otherwise fast models. This overhead will always have an effect on performance regardless of model size but may be less noticeable on larger models. Note that this XLA <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> execution performance may improve significantly with new torch features in the future.</p> <div class="section" id="example"> <h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">#</a></h3> <div class="sd-tab-set docutils"> <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-0"> Fixed Shape Example</label><div class="sd-tab-content docutils"> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="c1"># Create XLA device</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="c1"># Load example model and inputs to Neuron device</span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Sequential</span><span class="p">(</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">784</span><span class="p">,</span> <span class="mi">120</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">ReLU</span><span class="p">(),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">120</span><span class="p">,</span> <span class="mi">10</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Softmax</span><span class="p">(</span><span class="n">dim</span><span class="o">=-</span><span class="mi">1</span><span class="p">),</span> <span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">example</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span> <span class="mi">784</span><span class="p">),</span> <span class="n">device</span><span class="o">=</span><span class="n">device</span><span class="p">)</span> <span class="c1"># Inference</span> <span class="k">with</span> <span class="n">torch</span><span class="o">.</span><span class="n">no_grad</span><span class="p">():</span> <span class="n">result</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> <span class="c1"># Compilation occurs here</span> <span class="nb">print</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">cpu</span><span class="p">())</span> </pre></div> </div> </div> <input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-1"> Dynamic Shape Example</label><div class="sd-tab-content docutils"> <p>The following is an example of a model that dynamically changes the sequence length and batch size of the input token ID tensor to trigger recompilations. This kind of workflow would require padding when using traced inference.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="c1"># Create XLA device</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="c1"># Load example model and inputs to Neuron device</span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Sequential</span><span class="p">(</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Embedding</span><span class="p">(</span><span class="n">num_embeddings</span><span class="o">=</span><span class="mi">30522</span><span class="p">,</span> <span class="n">embedding_dim</span><span class="o">=</span><span class="mi">512</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">512</span><span class="p">,</span> <span class="mi">128</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">ReLU</span><span class="p">(),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">128</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Softmax</span><span class="p">(</span><span class="n">dim</span><span class="o">=-</span><span class="mi">1</span><span class="p">),</span> <span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">token_ids_1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">28</span><span class="p">,</span> <span class="mi">748</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">])</span> <span class="c1"># shape: [1, 4]</span> <span class="n">token_ids_2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">13087</span><span class="p">,</span> <span class="mi">10439</span><span class="p">,</span> <span class="mi">1990</span><span class="p">,</span> <span class="mi">18912</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">12009</span><span class="p">,</span> <span class="mi">7849</span><span class="p">,</span> <span class="mi">2509</span><span class="p">,</span> <span class="mi">3500</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">])</span> <span class="c1"># shape: [2, 6]</span> <span class="c1"># Inference</span> <span class="k">with</span> <span class="n">torch</span><span class="o">.</span><span class="n">no_grad</span><span class="p">():</span> <span class="c1"># First compilation/inference</span> <span class="n">result</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">token_ids_1</span><span class="p">)</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> <span class="nb">print</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">cpu</span><span class="p">())</span> <span class="c1"># shape: [1, 4, 2]</span> <span class="c1"># Recompilation occurs here since token_ids_2 is a different shape. This infer</span> <span class="c1"># would have failed if the model had been traced with shape [1, 4]</span> <span class="n">result</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">token_ids_2</span><span class="p">)</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> <span class="nb">print</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">cpu</span><span class="p">())</span> <span class="c1"># shape: [2, 6, 2]</span> </pre></div> </div> </div> </div> </div> </div> <div class="section" id="traced-inference-mechanics"> <h2><a class="toc-backref" href="#id4">Traced Inference Mechanics</a><a class="headerlink" href="#traced-inference-mechanics" title="Permalink to this headline">#</a></h2> <p>Traced inference uses Ahead-Of-Time (AOT) compilation for Neuron execution.</p> <p>Similar to XLA <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> inference, <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">trace()</span></code></a> uses the operation recording mechanisms provided by <code class="docutils literal notranslate"><span class="pre">torch-xla</span></code> to build the graph structure. This graph structure is also sent to the <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a> compiler to produce a binary (NEFF) that is executable on Neuron.</p> <p>The main difference is that the call to <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">trace()</span></code></a> returns a <em>new</em> fully compiled graph as a <a class="reference external" href="https://pytorch.org/docs/stable/jit.html">TorchScript</a> Module. Upon calling this new Module, rather than re-executing the python, rebuilding the graph, and checking the cache for a matching model, the new Module simply executes the precompiled graph that was preloaded during tracing. This is a significantly more optimized runtime since it avoids the python operator tracing, graph building, etc.</p> <p>One disadvantage of this interface is that a model will never dynamically recompile after a trace. This means that dynamic control flow is not supported within a function/module. Tensor input/output shapes are fixed to the shapes passed to the <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">trace()</span></code></a> API. Dynamic batching and bucketing can be used to avoid the pitfalls of static shapes.</p> <div class="section" id="id1"> <h3>Example<a class="headerlink" href="#id1" title="Permalink to this headline">#</a></h3> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="c1"># Create example model and inputs</span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Sequential</span><span class="p">(</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">784</span><span class="p">,</span> <span class="mi">120</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">ReLU</span><span class="p">(),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">120</span><span class="p">,</span> <span class="mi">10</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Softmax</span><span class="p">(</span><span class="n">dim</span><span class="o">=-</span><span class="mi">1</span><span class="p">),</span> <span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">example</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span> <span class="mi">784</span><span class="p">))</span> <span class="c1"># Create fixed model trace</span> <span class="n">trace</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example</span><span class="p">)</span> <span class="c1"># Inference</span> <span class="n">result</span> <span class="o">=</span> <span class="n">trace</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># No recompilation. Input shapes must not change</span> <span class="nb">print</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="traced-inference-advantages"> <h2><a class="toc-backref" href="#id5">Traced Inference Advantages</a><a class="headerlink" href="#traced-inference-advantages" title="Permalink to this headline">#</a></h2> <p>Traced inference should be used for nearly all deployment purposes since it provides some key advantages over XLA <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> execution:</p> <ul class="simple"> <li><p><strong>Reduced Overhead</strong>: There is no overhead associated with graph recording, compilation, and model loading since these steps are performed only once within the call to <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">trace()</span></code></a>. In contrast, when using XLA <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> inference, all of these steps are performed just-in-time (with caching to improve performance).</p></li> <li><p><strong>Serializable</strong>: The TorchScript Module that is produced from the <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">trace()</span></code></a> API is serializable using the normal <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.save.html#torch.jit.save" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.save()</span></code></a> function. It is able to be reloaded in an inference environment with <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>. In contrast, XLA device inference does not provide a predetermined serialization format that includes the pre-compiled NEFF artifacts. These must be manually copied to an inference environment to be used.</p></li> <li><p><strong>Reduced Dependencies</strong>: When using the traced TorchScript Module in an inference environment, it is no longer required to install the <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">neuronx-cc</span></a> compiler. In contrast, when using the XLA <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> execution, an execution may require a recompile to successfully infer.</p></li> <li><p><strong>Static &amp; Predictable</strong>: The resulting module produced by <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">trace()</span></code></a> will contain a static model that will consume a predictable amount of Neuron device memory and will never require recompilation based on input changes. In contrast, since XLA device inference performs just-in-time compilation, it can be more difficult to predict memory utilization and the compilations that may be required at inference time.</p></li> <li><p><strong>C++ Usability</strong>: If the end application is an inference platform using <code class="docutils literal notranslate"><span class="pre">libtorch</span></code>, it is easy to integrate with <code class="docutils literal notranslate"><span class="pre">libtorchneuron</span></code> to load traced modules. It is not currently possible to set up an environment to use torch in C++ in conjunction with Neuron XLA <a class="reference internal" href="#xla-lazytensor"><span class="std std-ref">Lazy Tensor</span></a> execution.</p></li> </ul> </div> <div class="section" id="summary"> <h2><a class="toc-backref" href="#id6">Summary</a><a class="headerlink" href="#summary" title="Permalink to this headline">#</a></h2> <table class="table"> <colgroup> <col style="width: 28%"> <col style="width: 40%"> <col style="width: 33%"> </colgroup> <thead> <tr class="row-odd"><th class="head"></th> <th class="head"><p>XLA Device Inference</p></th> <th class="head"><p>Traced Inference</p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p>Compilation</p></td> <td><p>JIT</p></td> <td><p>AOT</p></td> </tr> <tr class="row-odd"><td><p>Serialization</p></td> <td><p>N/A</p></td> <td><p><a class="reference external" href="https://pytorch.org/docs/stable/jit.html">TorchScript</a></p></td> </tr> <tr class="row-even"><td><p>Performance</p></td> <td><p>Slower</p></td> <td><p>Faster</p></td> </tr> <tr class="row-odd"><td><p>Dynamic</p></td> <td><p>Yes</p></td> <td><p>No</p></td> </tr> <tr class="row-even"><td><p>C++ Usage</p></td> <td><p>No</p></td> <td><p>Yes</p></td> </tr> </tbody> </table> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="core-placement.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">NeuronCore Allocation and Model Placement for Inference (<span class="xref std std-ref">torch-neuronx</span>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Data Parallel Inference on torch_neuronx</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:52.279Z
Data Parallel Inference on torch_neuronx — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html
# Data Parallel Inference on torch\_neuronx — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Data Parallel Inference on torch\_neuronx[#](#data-parallel-inference-on-torch-neuronx "Permalink to this headline") Table of Contents - [Introduction](#introduction) - [Data parallel inference](#data-parallel-inference) - [torch\_neuronx.DataParallel](#torch-neuronx-dataparallel) - [NeuronCore selection](#neuroncore-selection) - [Batch dim](#batch-dim) - [Dynamic batching](#dynamic-batching) - [Performance optimizations](#performance-optimizations) - [Examples](#examples) - [Default usage](#default-usage) - [Specifying NeuronCores](#specifying-neuroncores) - [DataParallel with dim != 0](#dataparallel-with-dim-0) - [Dynamic batching](#dataparallel-example-dynamic-batching-torch-neuronx) - [Dynamic batching disabled](#dynamic-batching-disabled) ## [Data parallel inference](#id3)[#](#data-parallel-inference "Permalink to this headline") Data Parallelism is a form of parallelization across multiple devices or cores, referred to as nodes. Each node contains the same model and parameters, but data is distributed across the different nodes. By distributing the data across multiple nodes, data parallelism reduces the total execution time of large batch size inputs compared to sequential execution. Data parallelism works best for smaller models in latency sensitive applications that have large batch size requirements. ## [torch\_neuronx.DataParallel](#id4)[#](#torch-neuronx-dataparallel "Permalink to this headline") To fully leverage the Inferentia hardware, we want to use all available NeuronCores. An inf2.xlarge and inf2.8xlarge have two NeuronCores, an inf2.24xlarge has 12 NeuronCores, and an inf2.48xlarge has 24 NeuronCores. For maximum performance on Inferentia hardware, we can use [`torch_neuronx.DataParallel()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel "torch_neuronx.DataParallel") to utilize all available NeuronCores. [`torch_neuronx.DataParallel()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel "torch_neuronx.DataParallel") implements data parallelism at the module level by replicating the Neuron model on all available NeuronCores and distributing data across the different cores for parallelized inference. This function is analogous to [`DataParallel`](https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") in PyTorch. [`torch_neuronx.DataParallel()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel "torch_neuronx.DataParallel") requires PyTorch >= 1.8. The following sections provide an overview of some of the features of [`torch_neuronx.DataParallel()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel "torch_neuronx.DataParallel") that enable maximum performance on Inferentia. ### [NeuronCore selection](#id5)[#](#neuroncore-selection "Permalink to this headline") By default, DataParallel will try to use all NeuronCores allocated to the current process to fully saturate the Inferentia hardware for maximum performance. It is more efficient to make the batch dimension divisible by the number of NeuronCores. This will ensure that NeuronCores are not left idle during parallel inference and the Inferentia hardware is fully utilized. In some applications, it is advantageous to use a subset of the available NeuronCores for DataParallel inference. DataParallel has a `device_ids` argument that accepts a list of [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") or `'nc:#'` that specify the NeuronCores to use for parallelization. See [Specifying NeuronCores](#dataparallel-example-specify-ncs-torch-neuronx) for an example of how to use `device_ids` argument. ### [Batch dim](#id6)[#](#batch-dim "Permalink to this headline") DataParallel accepts a `dim` argument that denotes the batch dimension used to split the input data for distributed inference. By default, DataParalell splits the inputs on `dim = 0` if the `dim` argument is not specified. For applications with a non-zero batch dim, the `dim` argument can be used to specify the inference-time input batch dimension. [DataParallel with dim ! = 0](#dataparallel-example-dim-neq-zero-torch-neuronx) provides an example of data parallel inference on inputs with batch dim = 2. ### [Dynamic batching](#id7)[#](#dynamic-batching "Permalink to this headline") Batch size has a direct impact on model performance. The Inferentia chip is optimized to run with small batch sizes. This means that a Neuron compiled model can outperform a GPU model, even if running single digit batch sizes. As a general best practice, we recommend optimizing your model’s throughput by compiling the model with a small batch size and gradually increasing it to find the peak throughput on Inferentia. Dynamic batching is a feature that allows you to use tensor batch sizes that the Neuron model was not originally compiled against. This is necessary because the underlying Inferentia hardware will always execute inferences with the batch size used during compilation. Fixed batch size execution allows tuning the input batch size for optimal performance. For example, batch size 1 may be best suited for an ultra-low latency on-demand inference application, while batch size > 1 can be used to maximize throughput for offline inferencing. Dynamic batching is implemented by slicing large input tensors into chunks that match the batch size used during the [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") compilation call. The [`torch_neuronx.DataParallel()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel "torch_neuronx.DataParallel") class automatically enables dynamic batching on eligible models. This allows us to run inference in applications that have inputs with a variable batch size without needing to recompile the model. See [Dynamic batching](#dataparallel-example-dynamic-batching-torch-neuronx) for an example of how DataParallel can be used to run inference on inputs with a dynamic batch size without needing to recompile the model. Dynamic batching using small batch sizes can result in sub-optimal throughput because it involves slicing tensors into chunks and iteratively sending data to the hardware. Using a larger batch size at compilation time can use the Inferentia hardware more efficiently in order to maximize throughput. You can test the tradeoff between individual request latency and total throughput by fine-tuning the input batch size. Automatic batching in the DataParallel module can be disabled using the `disable_dynamic_batching()` function as follows: ``` >>> model_parallel = torch_neuronx.DataParallel(model_neuron) >>> model_parallel.disable_dynamic_batching() ``` If dynamic batching is disabled, the compile-time batch size must be equal to the inference-time batch size divided by the number of NeuronCores. [DataParallel with dim != 0](#dataparallel-example-dim-neq-zero-torch-neuronx) and [Dynamic batching disabled](#dataparallel-example-disable-dynamic-batching-torch-neuronx) provide examples of running DataParallel inference with dynamic batching disabled. ### [Performance optimizations](#id8)[#](#performance-optimizations "Permalink to this headline") The DataParallel module has a `num_workers` attribute that can be used to specify the number of worker threads used for multithreaded inference. By default, `num_workers = 2 * number of NeuronCores`. This value can be fine tuned to optimize DataParallel performance. DataParallel has a `split_size` attribute that dictates the size of the input chunks that are distributed to each NeuronCore. By default, `split_size = max(1, input.shape[dim] // number of NeuronCores)`. This value can be modified to optimally match the inference input chunk size with the compile-time batch size. ## [Examples](#id9)[#](#examples "Permalink to this headline") The following sections provide example usages of the [`torch_neuronx.DataParallel()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel "torch_neuronx.DataParallel") module. ### [Default usage](#id10)[#](#default-usage "Permalink to this headline") The default DataParallel use mode will replicate the model on all available NeuronCores in the current process. The inputs will be split on `dim=0`. ``` import torch import torch_neuronx from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module model_parallel = torch_neuronx.DataParallel(model_neuron) # Create a batched input batch_size = 5 image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### [Specifying NeuronCores](#id11)[#](#specifying-neuroncores "Permalink to this headline") The following example uses the `device_ids` argument to use the first three NeuronCores for DataParallel inference. ``` import torch import torch_neuronx from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module, run on the first two NeuronCores # Equivalent to model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1]) model_parallel = torch_neuronx.DataParallel(model_neuron, device_ids=['nc:0', 'nc:1']) # Create a batched input batch_size = 5 image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### [DataParallel with dim != 0](#id12)[#](#dataparallel-with-dim-0 "Permalink to this headline") In this example we run DataParallel inference using two NeuronCores and `dim = 2`. Because `dim != 0`, dynamic batching is not enabled. Consequently, the DataParallel inference-time batch size must be two times the compile-time batch size. ``` import torch import torch_neuronx # Create an example model class Model(torch.nn.Module): def __init__(self): super().__init__() self.conv = torch.nn.Conv2d(3, 3, 3) def forward(self, x): return self.conv(x) + 1 model = Model() model.eval() # Compile with an example input image = torch.rand([1, 3, 8, 8]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module using 2 NeuronCores and dim = 2 model_parallel = torch_neuronx.DataParallel(model_neuron, device_ids=[0, 1], dim=2) # Create a batched input # Note that image_batched.shape[dim] / len(device_ids) == image.shape[dim] batch_size = 2 * 8 image_batched = torch.rand([1, 3, batch_size, 8]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### [Dynamic batching](#id13)[#](#dataparallel-example-dynamic-batching-torch-neuronx "Permalink to this headline") In the following example, we use the [`torch_neuronx.DataParallel()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel "torch_neuronx.DataParallel") module to run inference using several different batch sizes without recompiling the Neuron model. ``` import torch import torch_neuronx from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module model_parallel = torch_neuronx.DataParallel(model_neuron) # Create batched inputs and run inference on the same model batch_sizes = [2, 3, 4, 5, 6] for batch_size in batch_sizes: image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### [Dynamic batching disabled](#id14)[#](#dynamic-batching-disabled "Permalink to this headline") In the following example, we use `torch_neuronx.DataParallel.disable_dynamic_batching()` to disable dynamic batching. We provide an example of a batch size that will not work when dynamic batching is disabled as well as an example of a batch size that does work when dynamic batching is disabled. ``` import torch import torch_neuronx from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch_neuronx.trace(model, image) # Create the DataParallel module and use 2 NeuronCores model_parallel = torch_neuronx.DataParallel(model_neuron, device_ids=[0, 1], dim=0) # Disable dynamic batching model_parallel.disable_dynamic_batching() # Create a batched input (this won't work) batch_size = 4 image_batched = torch.rand([batch_size, 3, 224, 224]) # This will fail because dynamic batching is disabled and # image_batched.shape[dim] / len(device_ids) != image.shape[dim] # output = model_parallel(image_batched) # Create a batched input (this will work) batch_size = 2 image_batched = torch.rand([batch_size, 3, 224, 224]) # This will work because # image_batched.shape[dim] / len(device_ids) == image.shape[dim] output = model_parallel(image_batched) ``` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Data Parallel Inference on torch_neuronx — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Misc (torch-neuronx)" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> <link rel="prev" title="Comparison of Traced Inference versus XLA Lazy Tensor Inference (torch-neuronx)" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fgeneral/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#data-parallel-inference"> Data parallel inference </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-neuronx-dataparallel"> torch_neuronx.DataParallel </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-selection"> NeuronCore selection </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#batch-dim"> Batch dim </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#performance-optimizations"> Performance optimizations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-usage"> Default usage </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#specifying-neuroncores"> Specifying NeuronCores </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-with-dim-0"> DataParallel with dim != 0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-example-dynamic-batching-torch-neuronx"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching-disabled"> Dynamic batching disabled </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Data Parallel Inference on torch_neuronx</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#data-parallel-inference"> Data parallel inference </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-neuronx-dataparallel"> torch_neuronx.DataParallel </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-selection"> NeuronCore selection </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#batch-dim"> Batch dim </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#performance-optimizations"> Performance optimizations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-usage"> Default usage </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#specifying-neuroncores"> Specifying NeuronCores </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-with-dim-0"> DataParallel with dim != 0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-example-dynamic-batching-torch-neuronx"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching-disabled"> Dynamic batching disabled </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="data-parallel-inference-on-torch-neuronx"> <span id="torch-neuronx-dataparallel-app-note"></span><h1>Data Parallel Inference on torch_neuronx<a class="headerlink" href="#data-parallel-inference-on-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#introduction" id="id2">Introduction</a></p></li> <li><p><a class="reference internal" href="#data-parallel-inference" id="id3">Data parallel inference</a></p></li> <li><p><a class="reference internal" href="#torch-neuronx-dataparallel" id="id4">torch_neuronx.DataParallel</a></p> <ul> <li><p><a class="reference internal" href="#neuroncore-selection" id="id5">NeuronCore selection</a></p></li> <li><p><a class="reference internal" href="#batch-dim" id="id6">Batch dim</a></p></li> <li><p><a class="reference internal" href="#dynamic-batching" id="id7">Dynamic batching</a></p></li> <li><p><a class="reference internal" href="#performance-optimizations" id="id8">Performance optimizations</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#examples" id="id9">Examples</a></p> <ul> <li><p><a class="reference internal" href="#default-usage" id="id10">Default usage</a></p></li> <li><p><a class="reference internal" href="#specifying-neuroncores" id="id11">Specifying NeuronCores</a></p></li> <li><p><a class="reference internal" href="#dataparallel-with-dim-0" id="id12">DataParallel with dim != 0</a></p></li> <li><p><a class="reference internal" href="#dataparallel-example-dynamic-batching-torch-neuronx" id="id13">Dynamic batching</a></p></li> <li><p><a class="reference internal" href="#dynamic-batching-disabled" id="id14">Dynamic batching disabled</a></p></li> </ul> </li> </ul> </div> <div class="section" id="introduction"> <h2><a class="toc-backref" href="#id2">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">#</a></h2> <p>This guide introduces <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a>, a Python API that implements data parallelism on <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> models created by the <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch-neuronx-trace-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Tracing API for Inference</span></a>. The following sections explain how data parallelism can improve the performance of inference workloads on Inferentia, including how <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> uses dynamic batching to run inference on variable input sizes. It covers an overview of the <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> module and provides a few <a class="reference internal" href="#data-parallel-examples-torch-neuronx"><span class="std std-ref">example data parallel applications</span></a>.</p> </div> <div class="section" id="data-parallel-inference"> <h2><a class="toc-backref" href="#id3">Data parallel inference</a><a class="headerlink" href="#data-parallel-inference" title="Permalink to this headline">#</a></h2> <p>Data Parallelism is a form of parallelization across multiple devices or cores, referred to as nodes. Each node contains the same model and parameters, but data is distributed across the different nodes. By distributing the data across multiple nodes, data parallelism reduces the total execution time of large batch size inputs compared to sequential execution. Data parallelism works best for smaller models in latency sensitive applications that have large batch size requirements.</p> </div> <div class="section" id="torch-neuronx-dataparallel"> <h2><a class="toc-backref" href="#id4">torch_neuronx.DataParallel</a><a class="headerlink" href="#torch-neuronx-dataparallel" title="Permalink to this headline">#</a></h2> <p>To fully leverage the Inferentia hardware, we want to use all available NeuronCores. An inf2.xlarge and inf2.8xlarge have two NeuronCores, an inf2.24xlarge has 12 NeuronCores, and an inf2.48xlarge has 24 NeuronCores. For maximum performance on Inferentia hardware, we can use <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> to utilize all available NeuronCores.</p> <p><a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> implements data parallelism at the module level by replicating the Neuron model on all available NeuronCores and distributing data across the different cores for parallelized inference. This function is analogous to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParallel</span></code></a> in PyTorch. <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> requires PyTorch &gt;= 1.8.</p> <p>The following sections provide an overview of some of the features of <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> that enable maximum performance on Inferentia.</p> <div class="section" id="neuroncore-selection"> <h3><a class="toc-backref" href="#id5">NeuronCore selection</a><a class="headerlink" href="#neuroncore-selection" title="Permalink to this headline">#</a></h3> <p>By default, DataParallel will try to use all NeuronCores allocated to the current process to fully saturate the Inferentia hardware for maximum performance. It is more efficient to make the batch dimension divisible by the number of NeuronCores. This will ensure that NeuronCores are not left idle during parallel inference and the Inferentia hardware is fully utilized.</p> <p>In some applications, it is advantageous to use a subset of the available NeuronCores for DataParallel inference. DataParallel has a <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument that accepts a list of <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> or <code class="docutils literal notranslate"><span class="pre">'nc:#'</span></code> that specify the NeuronCores to use for parallelization. See <a class="reference internal" href="#dataparallel-example-specify-ncs-torch-neuronx"><span class="std std-ref">Specifying NeuronCores</span></a> for an example of how to use <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument.</p> </div> <div class="section" id="batch-dim"> <h3><a class="toc-backref" href="#id6">Batch dim</a><a class="headerlink" href="#batch-dim" title="Permalink to this headline">#</a></h3> <p>DataParallel accepts a <code class="docutils literal notranslate"><span class="pre">dim</span></code> argument that denotes the batch dimension used to split the input data for distributed inference. By default, DataParalell splits the inputs on <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">=</span> <span class="pre">0</span></code> if the <code class="docutils literal notranslate"><span class="pre">dim</span></code> argument is not specified. For applications with a non-zero batch dim, the <code class="docutils literal notranslate"><span class="pre">dim</span></code> argument can be used to specify the inference-time input batch dimension. <a class="reference internal" href="#dataparallel-example-dim-neq-zero-torch-neuronx"><span class="std std-ref">DataParallel with dim ! = 0</span></a> provides an example of data parallel inference on inputs with batch dim = 2.</p> </div> <div class="section" id="dynamic-batching"> <span id="dynamic-batching-description-torch-neuronx"></span><h3><a class="toc-backref" href="#id7">Dynamic batching</a><a class="headerlink" href="#dynamic-batching" title="Permalink to this headline">#</a></h3> <p>Batch size has a direct impact on model performance. The Inferentia chip is optimized to run with small batch sizes. This means that a Neuron compiled model can outperform a GPU model, even if running single digit batch sizes.</p> <p>As a general best practice, we recommend optimizing your model’s throughput by compiling the model with a small batch size and gradually increasing it to find the peak throughput on Inferentia.</p> <p>Dynamic batching is a feature that allows you to use tensor batch sizes that the Neuron model was not originally compiled against. This is necessary because the underlying Inferentia hardware will always execute inferences with the batch size used during compilation. Fixed batch size execution allows tuning the input batch size for optimal performance. For example, batch size 1 may be best suited for an ultra-low latency on-demand inference application, while batch size &gt; 1 can be used to maximize throughput for offline inferencing. Dynamic batching is implemented by slicing large input tensors into chunks that match the batch size used during the <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a> compilation call.</p> <p>The <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> class automatically enables dynamic batching on eligible models. This allows us to run inference in applications that have inputs with a variable batch size without needing to recompile the model. See <a class="reference internal" href="#dataparallel-example-dynamic-batching-torch-neuronx"><span class="std std-ref">Dynamic batching</span></a> for an example of how DataParallel can be used to run inference on inputs with a dynamic batch size without needing to recompile the model.</p> <p>Dynamic batching using small batch sizes can result in sub-optimal throughput because it involves slicing tensors into chunks and iteratively sending data to the hardware. Using a larger batch size at compilation time can use the Inferentia hardware more efficiently in order to maximize throughput. You can test the tradeoff between individual request latency and total throughput by fine-tuning the input batch size.</p> <p>Automatic batching in the DataParallel module can be disabled using the <code class="docutils literal notranslate"><span class="pre">disable_dynamic_batching()</span></code> function as follows:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model_parallel</span><span class="o">.</span><span class="n">disable_dynamic_batching</span><span class="p">()</span> </pre></div> </div> <p>If dynamic batching is disabled, the compile-time batch size must be equal to the inference-time batch size divided by the number of NeuronCores. <a class="reference internal" href="#dataparallel-example-dim-neq-zero-torch-neuronx"><span class="std std-ref">DataParallel with dim != 0</span></a> and <a class="reference internal" href="#dataparallel-example-disable-dynamic-batching-torch-neuronx"><span class="std std-ref">Dynamic batching disabled</span></a> provide examples of running DataParallel inference with dynamic batching disabled.</p> </div> <div class="section" id="performance-optimizations"> <h3><a class="toc-backref" href="#id8">Performance optimizations</a><a class="headerlink" href="#performance-optimizations" title="Permalink to this headline">#</a></h3> <p>The DataParallel module has a <code class="docutils literal notranslate"><span class="pre">num_workers</span></code> attribute that can be used to specify the number of worker threads used for multithreaded inference. By default, <code class="docutils literal notranslate"><span class="pre">num_workers</span> <span class="pre">=</span> <span class="pre">2</span> <span class="pre">*</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">NeuronCores</span></code>. This value can be fine tuned to optimize DataParallel performance.</p> <p>DataParallel has a <code class="docutils literal notranslate"><span class="pre">split_size</span></code> attribute that dictates the size of the input chunks that are distributed to each NeuronCore. By default, <code class="docutils literal notranslate"><span class="pre">split_size</span> <span class="pre">=</span> <span class="pre">max(1,</span> <span class="pre">input.shape[dim]</span> <span class="pre">//</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">NeuronCores)</span></code>. This value can be modified to optimally match the inference input chunk size with the compile-time batch size.</p> </div> </div> <div class="section" id="examples"> <span id="data-parallel-examples-torch-neuronx"></span><h2><a class="toc-backref" href="#id9">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline">#</a></h2> <p>The following sections provide example usages of the <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> module.</p> <div class="section" id="default-usage"> <span id="dataparallel-example-default-torch-neuronx"></span><h3><a class="toc-backref" href="#id10">Default usage</a><a class="headerlink" href="#default-usage" title="Permalink to this headline">#</a></h3> <p>The default DataParallel use mode will replicate the model on all available NeuronCores in the current process. The inputs will be split on <code class="docutils literal notranslate"><span class="pre">dim=0</span></code>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="c1"># Create a batched input</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">5</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="specifying-neuroncores"> <span id="dataparallel-example-specify-ncs-torch-neuronx"></span><h3><a class="toc-backref" href="#id11">Specifying NeuronCores</a><a class="headerlink" href="#specifying-neuroncores" title="Permalink to this headline">#</a></h3> <p>The following example uses the <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument to use the first three NeuronCores for DataParallel inference.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module, run on the first two NeuronCores</span> <span class="c1"># Equivalent to model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1])</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="s1">'nc:0'</span><span class="p">,</span> <span class="s1">'nc:1'</span><span class="p">])</span> <span class="c1"># Create a batched input</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">5</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dataparallel-with-dim-0"> <span id="dataparallel-example-dim-neq-zero-torch-neuronx"></span><h3><a class="toc-backref" href="#id12">DataParallel with dim != 0</a><a class="headerlink" href="#dataparallel-with-dim-0" title="Permalink to this headline">#</a></h3> <p>In this example we run DataParallel inference using two NeuronCores and <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">=</span> <span class="pre">2</span></code>. Because <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">!=</span> <span class="pre">0</span></code>, dynamic batching is not enabled. Consequently, the DataParallel inference-time batch size must be two times the compile-time batch size.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="c1"># Create an example model</span> <span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Model</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">8</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module using 2 NeuronCores and dim = 2</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="c1"># Create a batched input</span> <span class="c1"># Note that image_batched.shape[dim] / len(device_ids) == image.shape[dim]</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">2</span> <span class="o">*</span> <span class="mi">8</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="mi">8</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dataparallel-example-dynamic-batching-torch-neuronx"> <span id="id1"></span><h3><a class="toc-backref" href="#id13">Dynamic batching</a><a class="headerlink" href="#dataparallel-example-dynamic-batching-torch-neuronx" title="Permalink to this headline">#</a></h3> <p>In the following example, we use the <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch_neuronx.DataParallel" title="torch_neuronx.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel()</span></code></a> module to run inference using several different batch sizes without recompiling the Neuron model.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="c1"># Create batched inputs and run inference on the same model</span> <span class="n">batch_sizes</span> <span class="o">=</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]</span> <span class="k">for</span> <span class="n">batch_size</span> <span class="ow">in</span> <span class="n">batch_sizes</span><span class="p">:</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dynamic-batching-disabled"> <span id="dataparallel-example-disable-dynamic-batching-torch-neuronx"></span><h3><a class="toc-backref" href="#id14">Dynamic batching disabled</a><a class="headerlink" href="#dynamic-batching-disabled" title="Permalink to this headline">#</a></h3> <p>In the following example, we use <code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.DataParallel.disable_dynamic_batching()</span></code> to disable dynamic batching. We provide an example of a batch size that will not work when dynamic batching is disabled as well as an example of a batch size that does work when dynamic batching is disabled.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module and use 2 NeuronCores</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># Disable dynamic batching</span> <span class="n">model_parallel</span><span class="o">.</span><span class="n">disable_dynamic_batching</span><span class="p">()</span> <span class="c1"># Create a batched input (this won't work)</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># This will fail because dynamic batching is disabled and</span> <span class="c1"># image_batched.shape[dim] / len(device_ids) != image.shape[dim]</span> <span class="c1"># output = model_parallel(image_batched)</span> <span class="c1"># Create a batched input (this will work)</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">2</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># This will work because</span> <span class="c1"># image_batched.shape[dim] / len(device_ids) == image.shape[dim]</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Comparison of Traced Inference versus XLA <span class="xref std std-ref">Lazy Tensor</span> Inference (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Misc (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:53.050Z
Misc (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html
# Misc (torch-neuronx) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/misc-inference-torch-neuronx.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.rst) - [.rst](../../../_sources/frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.rst.txt) ## Misc (torch-neuronx) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Misc (`torch-neuronx`)[#](#misc-torch-neuronx "Permalink to this headline") - [PyTorch Neuron (torch-neuronx) release notes](../../../release-notes/torch/torch-neuronx/index.html#torch-neuronx-rn) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Misc (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuronx) release notes" href="../../../release-notes/torch/torch-neuronx/index.html"> <link rel="prev" title="Data Parallel Inference on torch_neuronx" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/misc-inference-torch-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/misc-inference-torch-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Misc (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="misc-torch-neuronx"> <h1>Misc (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#misc-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html#torch-neuronx-rn"><span class="std std-ref">PyTorch Neuron (torch-neuronx) release notes</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Data Parallel Inference on torch_neuronx</p> </div> </a> <a class="right-next" id="next-link" href="../../../release-notes/torch/torch-neuronx/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) release notes</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:54.036Z
PyTorch Neuron (torch-neuronx) release notes — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/release-notes/torch/torch-neuronx/index.html
# PyTorch Neuron (torch-neuronx) release notes — AWS Neuron Documentation ## PyTorch Neuron (`torch-neuronx`) release notes[#](#pytorch-neuron-torch-neuronx-release-notes "Permalink to this headline") Table of Contents - [Release \[1.13.1.1.11.0\]](#release-1-13-1-1-11-0) - [Release \[1.13.1.1.10.1\]](#release-1-13-1-1-10-1) - [Release \[1.13.1.1.10.0\]](#release-1-13-1-1-10-0) - [Release \[1.13.1.1.9.0\]](#release-1-13-1-1-9-0) - [Release \[1.13.1.1.8.0\]](#release-1-13-1-1-8-0) - [Release \[1.13.1.1.7.0\]](#release-1-13-1-1-7-0) - [Release \[1.13.0.1.6.1\]](#release-1-13-0-1-6-1) - [Release \[1.13.0.1.6.1\]](#id39) - [Release \[1.13.0.1.6.0\]](#release-1-13-0-1-6-0) - [Release \[1.13.0.1.5.0\]](#release-1-13-0-1-5-0) - [Release \[1.13.0.1.4.0\]](#release-1-13-0-1-4-0) - [Release \[1.12.0.1.4.0\]](#release-1-12-0-1-4-0) - [Release \[1.11.0.1.2.0\]](#release-1-11-0-1-2-0) - [Release \[1.11.0.1.1.1\]](#release-1-11-0-1-1-1) PyTorch Neuron for [Trn1](../../../general/arch/neuron-hardware/trn1-arch.html#aws-trn1-arch)/[Inf2](../../../general/arch/neuron-hardware/inf2-arch.html#aws-inf2-arch) is a software package that enables PyTorch users to train, evaluate, and perform inference on second-generation Neuron hardware (See: [NeuronCore-v2](../../../general/arch/neuron-hardware/neuron-core-v2.html#neuroncores-v2-arch)). ## [Release \[1.13.1.1.11.0\]](#id90)[#](#release-1-13-1-1-11-0 "Permalink to this headline") Date: 9/15/2023 ### Summary[#](#summary "Permalink to this headline") ## [Release \[1.13.1.1.10.1\]](#id91)[#](#release-1-13-1-1-10-1 "Permalink to this headline") Date: 9/01/2023 ### Summary[#](#id1 "Permalink to this headline") Minor bug fixes and enhancements. ## [Release \[1.13.1.1.10.0\]](#id92)[#](#release-1-13-1-1-10-0 "Permalink to this headline") Date: 8/28/2023 ### Summary[#](#id2 "Permalink to this headline") ### What’s new in this release[#](#what-s-new-in-this-release "Permalink to this headline") - Removed support for Python 3.7 - (Training) Added a neuron\_parallel\_compile command to clear file locks left behind when a neuron\_parallel\_compile execution was interrupted (neuron\_parallel\_compile –command clear-locks) - (Training) Seedable dropout now enabled by default ### Resolved Issues[#](#id3 "Permalink to this headline") - (Training) Convolution is now supported - Fixed segmentation fault when using torch-neuronx to compile models on U22 - Fixed XLA tensor stride information in torch-xla package, which blocked lowering of log\_softmax and similar functions which show errors like: ``` File "/home/ubuntu/waldronn/asr/test_env/lib/python3.7/site-packages/torch/nn/functional.py", line 1930, in log_softmax ret = input.log_softmax(dim) RuntimeError: dimensionality of sizes (3) must match dimensionality of strides (1) ``` ### Known Issues and Limitations (Training)[#](#known-issues-and-limitations-training "Permalink to this headline") #### Memory leaking in `glibc`[#](#memory-leaking-in-glibc "Permalink to this headline") `glibc` malloc memory leaks affect Neuron and may be temporarily limited by setting `MALLOC_ARENA_MAX`. #### Runtime crash when we use too many workers per node with DDP[#](#runtime-crash-when-we-use-too-many-workers-per-node-with-ddp "Permalink to this headline") Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: ``` bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files``. ``` Hence, it is recommended to use fewer workers per node with DDP. ### Known Issues and Limitations (Inference)[#](#known-issues-and-limitations-inference "Permalink to this headline") #### No automatic partitioning[#](#no-automatic-partitioning "Permalink to this headline") Currently, when Neuron encounters an operation that it does not support during [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace"), it may exit with the following compiler error: “Import of the HLO graph into the Neuron Compiler has failed. This may be caused by unsupported operators or an internal compiler error.” The intended behavior when tracing is to automatically partition the model into separate subgraphs that run on NeuronCores and subgraphs that run on CPU. This will be supported in a future release. See [PyTorch Neuron (torch-neuronx) - Supported Operators](../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators) for a list of supported operators. ## [Release \[1.13.1.1.9.0\]](#id93)[#](#release-1-13-1-1-9-0 "Permalink to this headline") Date: 7/19/2023 ### Summary[#](#id4 "Permalink to this headline") ### What’s new in this release[#](#id5 "Permalink to this headline") Training support: - Uses jemalloc as the primary malloc lib to avoid memory leak at checkpointing - Added support for ZeRO-1 along with [tutorial](../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html#zero1-gpt2-pretraining-tutorial) Inference support: - Add async load and lazy model load options to accelerate model loading - Optimize DataParallel API to load onto multiple cores simultaneously when device IDs specified in device\_ids are consecutive ### Resolved Issues (Training)[#](#resolved-issues-training "Permalink to this headline") - Remove extra graph creation in torch\_neuronx.optim.adamw when the beta/lr parameters values become 0 or 1. - Stability improvements and faster failure on hitting a fault in XRT server used by XLA. ### Known Issues and Limitations (Training)[#](#id6 "Permalink to this headline") #### Memory leaking in `glibc`[#](#id7 "Permalink to this headline") `glibc` malloc memory leaks affect Neuron and may be temporarily limited by setting `MALLOC_ARENA_MAX`. #### Convolution is not supported[#](#convolution-is-not-supported "Permalink to this headline") Convolution is not supported during training. #### Runtime crash when we use too many workers per node with DDP[#](#id9 "Permalink to this headline") Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: ``` bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files``. ``` Hence, it is recommended to use fewer workers per node with DDP. ### Known Issues and Limitations (Inference)[#](#id10 "Permalink to this headline") #### No automatic partitioning[#](#id12 "Permalink to this headline") Currently, when Neuron encounters an operation that it does not support during [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace"), it may exit with the following compiler error: “Import of the HLO graph into the Neuron Compiler has failed. This may be caused by unsupported operators or an internal compiler error.” The intended behavior when tracing is to automatically partition the model into separate subgraphs that run on NeuronCores and subgraphs that run on CPU. This will be supported in a future release. See [PyTorch Neuron (torch-neuronx) - Supported Operators](../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators) for a list of supported operators. ## [Release \[1.13.1.1.8.0\]](#id94)[#](#release-1-13-1-1-8-0 "Permalink to this headline") Date: 6/14/2023 ### Summary[#](#id14 "Permalink to this headline") - Added s3 caching to NeuronCache. - Added extract/compile/analyze phases to neuron\_parallel\_compile. ### What’s new in this release[#](#id15 "Permalink to this headline") Training support: - Added S3 caching support to NeuronCache. Removed NeuronCache options –cache\_size/cache\_ttl (please delete cache directories as needed). - Added separate extract and compile phases Neuron Parallel Compile. - Added model analyze API to Neuron Parallel Compile. ### Known Issues and Limitations (Training)[#](#id16 "Permalink to this headline") #### Memory leaking in `glibc`[#](#id17 "Permalink to this headline") `glibc` malloc memory leaks affect Neuron and may be temporarily limited by setting `MALLOC_ARENA_MAX`. #### Convolution is not supported[#](#id18 "Permalink to this headline") Convolution is not supported during training. #### Runtime crash when we use too many workers per node with DDP[#](#id20 "Permalink to this headline") Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: ``` bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files``. ``` Hence, it is recommended to use fewer workers per node with DDP. ### Known Issues and Limitations (Inference)[#](#id21 "Permalink to this headline") #### No automatic partitioning[#](#id23 "Permalink to this headline") Currently, when Neuron encounters an operation that it does not support during [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace"), this will cause an error. The intended behavior when tracing is to automatically partition the model into separate subgraphs that run on NeuronCores and subgraphs that run on CPU. See [PyTorch Neuron (torch-neuronx) - Supported Operators](../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators) for a list of supported operators. ## [Release \[1.13.1.1.7.0\]](#id95)[#](#release-1-13-1-1-7-0 "Permalink to this headline") Date: 05/01/2023 ### Summary[#](#id25 "Permalink to this headline") ### What’s new in this release[#](#id26 "Permalink to this headline") Training support: - Added an improved Neuron-optimized AdamW optimizer implementation. - Added an improved Neuron-optimized [`torch.nn.Dropout`](https://pytorch.org/docs/master/generated/torch.nn.Dropout.html#torch.nn.Dropout "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") implementation. - Added an assertion when the [`torch.nn.Dropout`](https://pytorch.org/docs/master/generated/torch.nn.Dropout.html#torch.nn.Dropout "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") argument `inplace=True` during training. This is currently not supported on Neuron. - Added XLA lowering for `aten::count_nonzero` Inference support: - Added profiling support for models compiled with [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") - Added torch\_neuronx.DataParallel for models compiled with [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") ### Resolved Issues (Training)[#](#id27 "Permalink to this headline") #### Resolved slower BERT bf16 Phase 1 Single Node Performance[#](#resolved-slower-bert-bf16-phase-1-single-node-performance "Permalink to this headline") As of the Neuron 2.9.0 release, [BERT phase 1 pretraining](../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html#hf-bert-pretraining-tutorial) performance has regressed by approximately 8-9% when executed on a _single node_ only (i.e. just one `trn1.32xlarge` instance). This is resolved in 2.10 release. #### Resolved lower throughput for BERT-large training on AL2 instances[#](#resolved-lower-throughput-for-bert-large-training-on-al2-instances "Permalink to this headline") Starting in release 2.7, we see a performance drop of roughly 5-10% for BERT model training on AL2 instances. This is resolved in release 2.10. ### Resolved Issues (Inference)[#](#resolved-issues-inference "Permalink to this headline") #### Error when using the original model after `torch_neuronx.trace`[#](#error-when-using-the-original-model-after-torch-neuronx-trace "Permalink to this headline") Fixed an issue where model parameters would be moved to the Neuron `'xla'` device during [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") and would no longer be available to execute on the original device. This made it more difficult to compare Neuron models against CPU since previously this would require manually moving parameters back to CPU. #### Error when using the `xm.xla_device()` object followed by using `torch_neuronx.trace`[#](#error-when-using-the-xm-xla-device-object-followed-by-using-torch-neuronx-trace "Permalink to this headline") Fixed an issue where XLA device execution and [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") could not be performed in the same python process. #### Error when executing `torch_neuronx.trace` with `torch.bfloat16` input/output tensors[#](#error-when-executing-torch-neuronx-trace-with-torch-bfloat16-input-output-tensors "Permalink to this headline") Fixed an issue where [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") could not compile models which consumed or produced `torch.bfloat16` values. ### Known Issues and Limitations (Training)[#](#id28 "Permalink to this headline") #### Memory leaking in `glibc`[#](#id29 "Permalink to this headline") `glibc` malloc memory leaks affect Neuron and may be temporarily limited by setting `MALLOC_ARENA_MAX`. #### Convolution is not supported[#](#id30 "Permalink to this headline") Convolution is not supported during training. #### Runtime crash when we use too many workers per node with DDP[#](#id32 "Permalink to this headline") Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: ``` bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files``. ``` Hence, it is recommended to use fewer workers per node with DDP. ### Known Issues and Limitations (Inference)[#](#id33 "Permalink to this headline") #### No automatic partitioning[#](#id35 "Permalink to this headline") Currently, when Neuron encounters an operation that it does not support during [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace"), this will cause an error. The intended behavior when tracing is to automatically partition the model into separate subgraphs that run on NeuronCores and subgraphs that run on CPU. See [PyTorch Neuron (torch-neuronx) - Supported Operators](../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators) for a list of supported operators. ## [Release \[1.13.0.1.6.1\]](#id96)[#](#release-1-13-0-1-6-1 "Permalink to this headline") Date: 04/19/2023 ### Summary[#](#id37 "Permalink to this headline") ### What’s new in this release[#](#id38 "Permalink to this headline") Training support: - No changes Inference support: - Enable deserialized TorchScript modules to be compiled with [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") ## [Release \[1.13.0.1.6.1\]](#id97)[#](#id39 "Permalink to this headline") Date: 04/19/2023 ### Summary[#](#id40 "Permalink to this headline") ### What’s new in this release[#](#id41 "Permalink to this headline") Training support: - No changes Inference support: - Enable deserialized TorchScript modules to be compiled with [`torch_neuronx.trace()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace "torch_neuronx.trace") ## [Release \[1.13.0.1.6.0\]](#id98)[#](#release-1-13-0-1-6-0 "Permalink to this headline") Date: 03/28/2023 ### Summary[#](#id42 "Permalink to this headline") ### What’s new in this release[#](#id43 "Permalink to this headline") Training support: - Added pipeline parallelism support in AWS Samples for Megatron-LM Inference support: - Added model analysis API: torch\_neuronx.analyze - Added HLO opcode support for: - kAtan2 - kAfterAll - kMap - Added XLA lowering support for: - aten::glu - aten::scatter\_reduce - Updated torch.nn.MSELoss to promote input data types to a compatible type ### Resolved Issues (Training)[#](#id44 "Permalink to this headline") #### GRPC timeout errors when running Megatron-LM GPT 6.7B tutorial on multiple instances[#](#grpc-timeout-errors-when-running-megatron-lm-gpt-6-7b-tutorial-on-multiple-instances "Permalink to this headline") When running AWS Samples for Megatron-LM GPT 6.7B tutorial over multiple instances, you may encounter GRPC timeout errors like below: ``` E0302 01:10:20.511231294 138645 chttp2_transport.cc:1098] Received a GOAWAY with error code ENHANCE_YOUR_CALM and debug data equal to "too_many_pings" 2023-03-02 01:10:20.511500: W tensorflow/core/distributed_runtime/rpc/grpc_remote_master.cc:157] RPC failed with status = "UNAVAILABLE: Too many pings" and grpc_error_string = "{"created":"@1677719420.511317309","description":"Error received from peer ipv4:10.1.35.105:54729","file":"external/com_github_grpc_grpc/src/core/lib/surface/call.cc","file_line":1056,"grpc_message":"Too many pings","grpc_status":14}", maybe retrying the RPC ``` or: ``` 2023-03-08 21:18:27.040863: F tensorflow/compiler/xla/xla_client/xrt_computation_client.cc:476] Non-OK-status: session->session()->Run(session_work->feed_inputs, session_work->outputs_handles, &outputs) status: UNKNOWN: Stream removed ``` This is due to excessive DNS lookups during execution, and is fixed in this release. #### NaNs seen with transformers version >= 4.21.0 when running HF GPT fine-tuning or pretraining with XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1[#](#nans-seen-with-transformers-version-4-21-0-when-running-hf-gpt-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1 "Permalink to this headline") Using Hugging Face transformers version >= 4.21.0 can produce NaN outputs for GPT models when using full BF16 (XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1) plus stochastic rounding. This issue occurs due to large negative constants used to implement attention masking ([https://github.com/huggingface/transformers/pull/17306](https://github.com/huggingface/transformers/pull/17306)). To workaround this issue, please use transformers version <= 4.20.0. ### Resolved Issues (Inference)[#](#id45 "Permalink to this headline") #### [`torch.argmax()`](https://pytorch.org/docs/master/generated/torch.argmax.html#torch.argmax "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") now supports single argument call variant[#](#torch-argmax-now-supports-single-argument-call-variant "Permalink to this headline") Previously only the 3 argument variant of [`torch.argmax()`](https://pytorch.org/docs/master/generated/torch.argmax.html#torch.argmax "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") was supported. Now the single argument call variant is supported. ### Known Issues and Limitations (Training)[#](#id46 "Permalink to this headline") #### Slower BERT bf16 Phase 1 Single Node Performance[#](#slower-bert-bf16-phase-1-single-node-performance "Permalink to this headline") In the Neuron 2.9.0 release, [BERT phase 1 pretraining](../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html#hf-bert-pretraining-tutorial) performance has regressed by approximately 8-9% when executed on a _single node_ only (i.e. just one `trn1.32xlarge` instance). #### Convolution is not supported[#](#id47 "Permalink to this headline") In this release, convolution is not supported. #### Runtime crash when we use too many workers per node with DDP[#](#id49 "Permalink to this headline") Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: `bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files`. Hence, it is recommended to use fewer workers per node with DDP. #### Lower throughput for BERT-large training on AL2 instances[#](#lower-throughput-for-bert-large-training-on-al2-instances "Permalink to this headline") We see a performance drop of roughly 5-10% for BERT model training on AL2 instances. This is because of the increase in time required for tracing the model. ### Known Issues and Limitations (Inference)[#](#id50 "Permalink to this headline") #### Error when using the `xm.xla_device()` object followed by using `torch_neuronx.trace`[#](#id52 "Permalink to this headline") Executing a model using the `xm.xla_device()` object followed by using `torch_neuronx.trace` in the same process can produce errors in specific situations due to torch-xla caching behavior. It is recommended that only one type of execution is used per process. #### Error when executing `torch_neuronx.trace` with `torch.bfloat16` input/output tensors[#](#id53 "Permalink to this headline") Executing `torch_neuronx.trace` with `torch.bfloat16` input/output tensors can cause an error. It is currently recommended to use an alternative torch data type in combination with compiler casting flags instead. #### No automatic partitioning[#](#id54 "Permalink to this headline") Currently, there’s no automatic partitioning of a model into subgraphs that run on NeuronCores and subgraphs that run on CPU Operations in the model that are not supported by Neuron would result in compilation error. Please see [PyTorch Neuron (torch-neuronx) - Supported Operators](../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators) for a list of supported operators. ## [Release \[1.13.0.1.5.0\]](#id99)[#](#release-1-13-0-1-5-0 "Permalink to this headline") Date: 02/24/2023 ### Summary[#](#id55 "Permalink to this headline") ### What’s new in this release[#](#id56 "Permalink to this headline") Training support: - Added SPMD flag for XLA backend to generate global collective-compute replica groups Inference support: - Expanded inference support to inf2 - Added Dynamic Batching ### Resolved Issues[#](#id57 "Permalink to this headline") ### Known Issues and Limitations (Training)[#](#id58 "Permalink to this headline") #### Convolution is not supported[#](#id59 "Permalink to this headline") In this release, convolution is not supported. #### Runtime crash when we use too many workers per node with DDP[#](#id61 "Permalink to this headline") Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: `bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files`. Hence, it is recommended to use fewer workers per node with DDP. #### Lower throughput for BERT-large training on AL2 instances[#](#id62 "Permalink to this headline") We see a performance drop of roughly 5-10% for BERT model training on AL2 instances. This is because of the increase in time required for tracing the model. ### Known Issues and Limitations (Inference)[#](#id63 "Permalink to this headline") #### [`torch.argmax()`](https://pytorch.org/docs/master/generated/torch.argmax.html#torch.argmax "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") and [`torch.argmin()`](https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") do not support the single argument call variant[#](#torch-argmax-and-torch-argmin-do-not-support-the-single-argument-call-variant "Permalink to this headline") [`torch.argmax()`](https://pytorch.org/docs/master/generated/torch.argmax.html#torch.argmax "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") and [`torch.argmin()`](https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") do not support the single argument call variant. Only the 3 argument variant of these functions is supported. The `dim` argument _must be_ specified or this function will fail at the call-site. Secondly, [`torch.argmin()`](https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") may produce incorrect results. #### No automatic partitioning[#](#id64 "Permalink to this headline") Currently, there’s no automatic partitioning of a model into subgraphs that run on NeuronCores and subgraphs that run on CPU Operations in the model that are not supported by Neuron would result in compilation error. Please see [PyTorch Neuron (torch-neuronx) - Supported Operators](../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators) for a list of supported operators. ## [Release \[1.13.0.1.4.0\]](#id100)[#](#release-1-13-0-1-4-0 "Permalink to this headline") Date: 02/08/2023 ### Summary[#](#id65 "Permalink to this headline") ### What’s new in this release[#](#id66 "Permalink to this headline") Training support: - Added support for PyTorch 1.13 - Added support for Python version 3.9 - Added support for torch.nn.parallel.DistributedDataParallel (DDP) along with a tutorial - Added optimized lowering for Softmax activation - Added support for LAMB optimizer in BF16 mode Added initial support for inference on Trn1, including the following features: - Trace API (torch\_neuronx.trace) - Core placement API (experimental) - Python 3.7, 3.8 and 3.9 support - Support for tracing models larger than 2 GB The following inference features are not included in this release: - Automatic partitioning of a model into subgraphs that run on NeuronCores and subgraphs that run on CPU - cxx11 ABI wheels ### Resolved Issues[#](#id67 "Permalink to this headline") ### Known Issues and Limitations[#](#known-issues-and-limitations "Permalink to this headline") #### Convolution is not supported[#](#id68 "Permalink to this headline") In this release, convolution is not supported. #### Runtime crash when we use too many workers per node with DDP[#](#id70 "Permalink to this headline") Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: `bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files`. Hence, it is recommended to use fewer workers per node with DDP. #### Lower throughput for BERT-large training on AL2 instances[#](#id71 "Permalink to this headline") We see a performance drop of roughly 5-10% for BERT model training on AL2 instances. This is because of the increase in time required for tracing the model. ## [Release \[1.12.0.1.4.0\]](#id101)[#](#release-1-12-0-1-4-0 "Permalink to this headline") Date: 12/12/2022 ### Summary[#](#id72 "Permalink to this headline") ### What’s new in this release[#](#whats-new-in-this-release "Permalink to this headline") - Added support for PyTorch 1.12. - Setting XLA\_DOWNCAST\_BF16=1 now also enables stochastic rounding by default (as done with XLA\_USE\_BF16=1). - Added support for [capturing snapshots](../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html#torch-neuronx-snapshotting) of inputs, outputs and graph HLO for debug. - Fixed issue with parallel compile error when both train and evaluation are enabled in HuggingFace fine-tuning tutorial. - Added support for LAMB optimizer in FP32 mode. ### Resolved Issues[#](#id73 "Permalink to this headline") #### NaNs seen with transformers version >= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1[#](#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1 "Permalink to this headline") When running HuggingFace BERT (any size) fine-tuning tutorial or pretraining tutorial with transformers version >= 4.21.0 and using XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1, you will see NaNs in the loss immediately at the first step. More details on the issue can be found at [pytorch/xla#4152](https://github.com/pytorch/xla/issues/4152). The workaround is to use 4.20.0 or earlier (the tutorials currently recommend version 4.15.0) or add the line `transformers.modeling_utils.get_parameter_dtype = lambda x: torch.bfloat16` to your Python training script (as now done in latest tutorials). [A permanent fix](https://github.com/huggingface/transformers/pull/20562) will become part of an upcoming HuggingFace transformers release. ### Known Issues and Limitations[#](#id74 "Permalink to this headline") #### Convolution is not supported[#](#id75 "Permalink to this headline") In this release, convolution is not supported. #### Number of data parallel training workers on one Trn1 instance[#](#number-of-data-parallel-training-workers-on-one-trn1-instance "Permalink to this headline") The number of workers used in single-instance data parallel training can be one of the following values: 1 or 2 for trn1.2xlarge and 1, 2, 8 or 32 for trn1.32xlarge. ## [Release \[1.11.0.1.2.0\]](#id102)[#](#release-1-11-0-1-2-0 "Permalink to this headline") Date: 10/27/2022 ### Summary[#](#id76 "Permalink to this headline") ### What’s new in this release[#](#id77 "Permalink to this headline") - Added support for argmax. - Clarified error messages for runtime errors `NRT_UNINITIALIZED` and `NRT_CLOSED`. - When multi-worker training is launched using torchrun on one instance, framework now handles runtime state cleanup at end of training. ### Resolved Issues[#](#id78 "Permalink to this headline") #### Drop-out rate ignored in dropout operation[#](#drop-out-rate-ignored-in-dropout-operation "Permalink to this headline") A known issue in the compiler’s implementation of dropout caused drop-rate to be ignored in the last release. It is fixed in the current release. #### Runtime error “invalid offset in Coalesced\_memloc\_…” followed by “Failed to process dma block: 1703”[#](#runtime-error-invalid-offset-in-coalesced-memloc-followed-by-failed-to-process-dma-block-1703 "Permalink to this headline") Previously, when running MRPC fine-tuning tutorial with `bert-base-*` model, you would encounter runtime error “invalid offset in Coalesced\_memloc\_…” followed by “Failed to process dma block: 1703”. This is fixed in the current release. #### Compilation error: “TongaSBTensor\[0x7fb2a46e0830\]:TongaSB partitions\[0\] uint8 %138392\[128, 512\]”[#](#compilation-error-tongasbtensor-0x7fb2a46e0830-tongasb-partitions-0-uint8-138392-128-512 "Permalink to this headline") Previously, when compiling MRPC fine-tuning tutorial with `bert-large-*` and FP32 (no XLA\_USE\_BF16=1) for two workers or more, you would encounter compiler error that looks like `Error message:  TongaSBTensor[0x7fb2a46e0830]:TongaSB partitions[0] uint8 %138392[128, 512]` followed by `Error class:    KeyError`. Single worker fine-tuning is not affected. This is fixed in the current release. ### Known Issues and Limitations[#](#id79 "Permalink to this headline") #### Convolution is not supported[#](#id80 "Permalink to this headline") In this release, convolution is not supported. #### Number of data parallel training workers on one Trn1 instance[#](#id81 "Permalink to this headline") The number of workers used in single-instance data parallel training can be one of the following values: 1 or 2 for trn1.2xlarge and 1, 2, 8 or 32 for trn1.32xlarge. ## [Release \[1.11.0.1.1.1\]](#id103)[#](#release-1-11-0-1-1-1 "Permalink to this headline") Date: 10/10/2022 ### Summary[#](#id82 "Permalink to this headline") This is the initial release of PyTorch Neuron that supports Trainium for users to train their models on the new EC2 Trn1 instances. ### What’s new in this release[#](#id83 "Permalink to this headline") Announcing the first PyTorch Neuron release for training. - XLA device support for Trainium - PyTorch 1.11 with XLA backend support in torch.distributed - torch-xla distributed support - Single-instance and multi-instance distributed training using torchrun - Support for ParallelCluster and SLURM with node-level scheduling granularity - Persistent cache for compiled graph - [neuron\_parallel\_compile](../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli) utility to help speed up compilation - Optimizer support: SGD, AdamW - Loss functions supported: NLLLoss - Python versions supported: 3.7, 3.8 - Multi-instance training support with EFA - Support PyTorch’s BF16 automatic mixed precision ### Known Issues and Limitations[#](#id84 "Permalink to this headline") #### Convolution is not supported[#](#id85 "Permalink to this headline") In this release, convolution is not supported. #### Number of data parallel training workers on one Trn1 instance[#](#id86 "Permalink to this headline") The number of workers used in single-instance data parallel training can be one of the following values: 1 or 2 for trn1.2xlarge and 1, 2, 8 or 32 for trn1.32xlarge. #### Drop-out rate ignored in dropout operation[#](#id87 "Permalink to this headline") A known issue in the compiler’s implementation of dropout caused drop-rate to be ignored. Will be fixed in a follow-on release. #### Runtime error “invalid offset in Coalesced\_memloc\_…” followed by “Failed to process dma block: 1703”[#](#id88 "Permalink to this headline") Currently, when running MRPC fine-tuning tutorial with `bert-base-*` model, you will encounter runtime error “invalid offset in Coalesced\_memloc\_…” followed by “Failed to process dma block: 1703”. This issue will be fixed in an upcoming release. #### Compilation error: “TongaSBTensor\[0x7fb2a46e0830\]:TongaSB partitions\[0\] uint8 %138392\[128, 512\]”[#](#id89 "Permalink to this headline") When compiling MRPC fine-tuning tutorial with `bert-large-*` and FP32 (no XLA\_USE\_BF16=1) for two workers or more, you will encounter compiler error that looks like `Error message:  TongaSBTensor[0x7fb2a46e0830]:TongaSB partitions[0] uint8 %138392[128, 512]` followed by `Error class:    KeyError`. Single worker fine-tuning is not affected. This issue will be fixed in an upcoming release. _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuronx) release notes — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Inference with torch-neuron (Inf1)" href="../../../frameworks/torch/inference-torch-neuron.html"> <link rel="prev" title="Misc (torch-neuronx)" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "release-notes/torch/torch-neuronx/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Frelease-notes/torch/torch-neuronx/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/release-notes/torch/torch-neuronx/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/release-notes/torch/torch-neuronx/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-11-0"> Release [1.13.1.1.11.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-10-1"> Release [1.13.1.1.10.1] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-10-0"> Release [1.13.1.1.10.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#what-s-new-in-this-release"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id3"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-training"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#memory-leaking-in-glibc"> Memory leaking in <code class="docutils literal notranslate"> <span class="pre"> glibc </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#ddp-shows-slow-convergence"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#runtime-crash-when-we-use-too-many-workers-per-node-with-ddp"> Runtime crash when we use too many workers per node with DDP </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-inference"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-argmin-produces-incorrect-results"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#no-automatic-partitioning"> No automatic partitioning </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#torchscript-serialization-error-with-compiled-artifacts-larger-than-4gb"> Torchscript serialization error with compiled artifacts larger than 4GB </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-9-0"> Release [1.13.1.1.9.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id4"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id5"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-training"> Resolved Issues (Training) </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id6"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id7"> Memory leaking in <code class="docutils literal notranslate"> <span class="pre"> glibc </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#convolution-is-not-supported"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id8"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id9"> Runtime crash when we use too many workers per node with DDP </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id10"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id11"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id12"> No automatic partitioning </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id13"> Torchscript serialization error with compiled artifacts larger than 4GB </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-8-0"> Release [1.13.1.1.8.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id14"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id15"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id16"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id17"> Memory leaking in <code class="docutils literal notranslate"> <span class="pre"> glibc </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id18"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id19"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id20"> Runtime crash when we use too many workers per node with DDP </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id21"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id22"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id23"> No automatic partitioning </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id24"> Torchscript serialization error with compiled artifacts larger than 4GB </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-7-0"> Release [1.13.1.1.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id25"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id26"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id27"> Resolved Issues (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#unexpected-behavior-with-torch-autocast"> Unexpected behavior with <code class="xref py py-class docutils literal notranslate"> <span class="pre"> torch.autocast </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-slower-bert-bf16-phase-1-single-node-performance"> Resolved slower BERT bf16 Phase 1 Single Node Performance </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-lower-throughput-for-bert-large-training-on-al2-instances"> Resolved lower throughput for BERT-large training on AL2 instances </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-inference"> Resolved Issues (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-when-using-the-original-model-after-torch-neuronx-trace"> Error when using the original model after <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-when-using-the-xm-xla-device-object-followed-by-using-torch-neuronx-trace"> Error when using the <code class="docutils literal notranslate"> <span class="pre"> xm.xla_device() </span> </code> object followed by using <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-when-executing-torch-neuronx-trace-with-torch-bfloat16-input-output-tensors"> Error when executing <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> with <code class="docutils literal notranslate"> <span class="pre"> torch.bfloat16 </span> </code> input/output tensors </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id28"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id29"> Memory leaking in <code class="docutils literal notranslate"> <span class="pre"> glibc </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id30"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id31"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id32"> Runtime crash when we use too many workers per node with DDP </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id33"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id34"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id35"> No automatic partitioning </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id36"> Torchscript serialization error with compiled artifacts larger than 4GB </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-0-1-6-1"> Release [1.13.0.1.6.1] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id37"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id38"> What’s new in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id39"> Release [1.13.0.1.6.1] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id40"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id41"> What’s new in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-0-1-6-0"> Release [1.13.0.1.6.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id42"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id43"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id44"> Resolved Issues (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#grpc-timeout-errors-when-running-megatron-lm-gpt-6-7b-tutorial-on-multiple-instances"> GRPC timeout errors when running Megatron-LM GPT 6.7B tutorial on multiple instances </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-gpt-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> NaNs seen with transformers version &gt;= 4.21.0 when running HF GPT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1 </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id45"> Resolved Issues (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-argmax-now-supports-single-argument-call-variant"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmax() </span> </code> now supports single argument call variant </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id46"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#slower-bert-bf16-phase-1-single-node-performance"> Slower BERT bf16 Phase 1 Single Node Performance </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id47"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id48"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id49"> Runtime crash when we use too many workers per node with DDP </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#lower-throughput-for-bert-large-training-on-al2-instances"> Lower throughput for BERT-large training on AL2 instances </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id50"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id51"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id52"> Error when using the <code class="docutils literal notranslate"> <span class="pre"> xm.xla_device() </span> </code> object followed by using <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id53"> Error when executing <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> with <code class="docutils literal notranslate"> <span class="pre"> torch.bfloat16 </span> </code> input/output tensors </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id54"> No automatic partitioning </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-0-1-5-0"> Release [1.13.0.1.5.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id55"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id56"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id57"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id58"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id59"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id60"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id61"> Runtime crash when we use too many workers per node with DDP </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id62"> Lower throughput for BERT-large training on AL2 instances </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id63"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-argmax-and-torch-argmin-do-not-support-the-single-argument-call-variant"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmax() </span> </code> and <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> do not support the single argument call variant </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id64"> No automatic partitioning </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-0-1-4-0"> Release [1.13.0.1.4.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id65"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id66"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id67"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known Issues and Limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id68"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id69"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id70"> Runtime crash when we use too many workers per node with DDP </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id71"> Lower throughput for BERT-large training on AL2 instances </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-12-0-1-4-0"> Release [1.12.0.1.4.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id72"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#whats-new-in-this-release"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id73"> Resolved Issues </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1 </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id74"> Known Issues and Limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id75"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#number-of-data-parallel-training-workers-on-one-trn1-instance"> Number of data parallel training workers on one Trn1 instance </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-11-0-1-2-0"> Release [1.11.0.1.2.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id76"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id77"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id78"> Resolved Issues </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#drop-out-rate-ignored-in-dropout-operation"> Drop-out rate ignored in dropout operation </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#runtime-error-invalid-offset-in-coalesced-memloc-followed-by-failed-to-process-dma-block-1703"> Runtime error “invalid offset in Coalesced_memloc_…” followed by “Failed to process dma block: 1703” </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#compilation-error-tongasbtensor-0x7fb2a46e0830-tongasb-partitions-0-uint8-138392-128-512"> Compilation error: “TongaSBTensor[0x7fb2a46e0830]:TongaSB partitions[0] uint8 %138392[128, 512]” </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id79"> Known Issues and Limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id80"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id81"> Number of data parallel training workers on one Trn1 instance </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-11-0-1-1-1"> Release [1.11.0.1.1.1] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id82"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id83"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id84"> Known Issues and Limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id85"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id86"> Number of data parallel training workers on one Trn1 instance </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id87"> Drop-out rate ignored in dropout operation </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id88"> Runtime error “invalid offset in Coalesced_memloc_…” followed by “Failed to process dma block: 1703” </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id89"> Compilation error: “TongaSBTensor[0x7fb2a46e0830]:TongaSB partitions[0] uint8 %138392[128, 512]” </a> </li> </ul> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuronx) release notes</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-11-0"> Release [1.13.1.1.11.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-10-1"> Release [1.13.1.1.10.1] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-10-0"> Release [1.13.1.1.10.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#what-s-new-in-this-release"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id3"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-training"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#memory-leaking-in-glibc"> Memory leaking in <code class="docutils literal notranslate"> <span class="pre"> glibc </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#ddp-shows-slow-convergence"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#runtime-crash-when-we-use-too-many-workers-per-node-with-ddp"> Runtime crash when we use too many workers per node with DDP </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-inference"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-argmin-produces-incorrect-results"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#no-automatic-partitioning"> No automatic partitioning </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#torchscript-serialization-error-with-compiled-artifacts-larger-than-4gb"> Torchscript serialization error with compiled artifacts larger than 4GB </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-9-0"> Release [1.13.1.1.9.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id4"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id5"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-training"> Resolved Issues (Training) </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id6"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id7"> Memory leaking in <code class="docutils literal notranslate"> <span class="pre"> glibc </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#convolution-is-not-supported"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id8"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id9"> Runtime crash when we use too many workers per node with DDP </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id10"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id11"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id12"> No automatic partitioning </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id13"> Torchscript serialization error with compiled artifacts larger than 4GB </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-8-0"> Release [1.13.1.1.8.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id14"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id15"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id16"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id17"> Memory leaking in <code class="docutils literal notranslate"> <span class="pre"> glibc </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id18"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id19"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id20"> Runtime crash when we use too many workers per node with DDP </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id21"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id22"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id23"> No automatic partitioning </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id24"> Torchscript serialization error with compiled artifacts larger than 4GB </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-1-1-7-0"> Release [1.13.1.1.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id25"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id26"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id27"> Resolved Issues (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#unexpected-behavior-with-torch-autocast"> Unexpected behavior with <code class="xref py py-class docutils literal notranslate"> <span class="pre"> torch.autocast </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-slower-bert-bf16-phase-1-single-node-performance"> Resolved slower BERT bf16 Phase 1 Single Node Performance </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-lower-throughput-for-bert-large-training-on-al2-instances"> Resolved lower throughput for BERT-large training on AL2 instances </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-inference"> Resolved Issues (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-when-using-the-original-model-after-torch-neuronx-trace"> Error when using the original model after <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-when-using-the-xm-xla-device-object-followed-by-using-torch-neuronx-trace"> Error when using the <code class="docutils literal notranslate"> <span class="pre"> xm.xla_device() </span> </code> object followed by using <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-when-executing-torch-neuronx-trace-with-torch-bfloat16-input-output-tensors"> Error when executing <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> with <code class="docutils literal notranslate"> <span class="pre"> torch.bfloat16 </span> </code> input/output tensors </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id28"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id29"> Memory leaking in <code class="docutils literal notranslate"> <span class="pre"> glibc </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id30"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id31"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id32"> Runtime crash when we use too many workers per node with DDP </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id33"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id34"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id35"> No automatic partitioning </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id36"> Torchscript serialization error with compiled artifacts larger than 4GB </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-0-1-6-1"> Release [1.13.0.1.6.1] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id37"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id38"> What’s new in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id39"> Release [1.13.0.1.6.1] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id40"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id41"> What’s new in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-0-1-6-0"> Release [1.13.0.1.6.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id42"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id43"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id44"> Resolved Issues (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#grpc-timeout-errors-when-running-megatron-lm-gpt-6-7b-tutorial-on-multiple-instances"> GRPC timeout errors when running Megatron-LM GPT 6.7B tutorial on multiple instances </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-gpt-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> NaNs seen with transformers version &gt;= 4.21.0 when running HF GPT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1 </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id45"> Resolved Issues (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-argmax-now-supports-single-argument-call-variant"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmax() </span> </code> now supports single argument call variant </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id46"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#slower-bert-bf16-phase-1-single-node-performance"> Slower BERT bf16 Phase 1 Single Node Performance </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id47"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id48"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id49"> Runtime crash when we use too many workers per node with DDP </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#lower-throughput-for-bert-large-training-on-al2-instances"> Lower throughput for BERT-large training on AL2 instances </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id50"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id51"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> produces incorrect results </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id52"> Error when using the <code class="docutils literal notranslate"> <span class="pre"> xm.xla_device() </span> </code> object followed by using <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id53"> Error when executing <code class="docutils literal notranslate"> <span class="pre"> torch_neuronx.trace </span> </code> with <code class="docutils literal notranslate"> <span class="pre"> torch.bfloat16 </span> </code> input/output tensors </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id54"> No automatic partitioning </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-0-1-5-0"> Release [1.13.0.1.5.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id55"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id56"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id57"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id58"> Known Issues and Limitations (Training) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id59"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id60"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id61"> Runtime crash when we use too many workers per node with DDP </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id62"> Lower throughput for BERT-large training on AL2 instances </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id63"> Known Issues and Limitations (Inference) </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-argmax-and-torch-argmin-do-not-support-the-single-argument-call-variant"> <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmax() </span> </code> and <code class="xref py py-func docutils literal notranslate"> <span class="pre"> torch.argmin() </span> </code> do not support the single argument call variant </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id64"> No automatic partitioning </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-13-0-1-4-0"> Release [1.13.0.1.4.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id65"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id66"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id67"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known Issues and Limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id68"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id69"> DDP shows slow convergence </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id70"> Runtime crash when we use too many workers per node with DDP </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id71"> Lower throughput for BERT-large training on AL2 instances </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-12-0-1-4-0"> Release [1.12.0.1.4.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id72"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#whats-new-in-this-release"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id73"> Resolved Issues </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1 </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id74"> Known Issues and Limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id75"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#number-of-data-parallel-training-workers-on-one-trn1-instance"> Number of data parallel training workers on one Trn1 instance </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-11-0-1-2-0"> Release [1.11.0.1.2.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id76"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id77"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id78"> Resolved Issues </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#drop-out-rate-ignored-in-dropout-operation"> Drop-out rate ignored in dropout operation </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#runtime-error-invalid-offset-in-coalesced-memloc-followed-by-failed-to-process-dma-block-1703"> Runtime error “invalid offset in Coalesced_memloc_…” followed by “Failed to process dma block: 1703” </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#compilation-error-tongasbtensor-0x7fb2a46e0830-tongasb-partitions-0-uint8-138392-128-512"> Compilation error: “TongaSBTensor[0x7fb2a46e0830]:TongaSB partitions[0] uint8 %138392[128, 512]” </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id79"> Known Issues and Limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id80"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id81"> Number of data parallel training workers on one Trn1 instance </a> </li> </ul> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#release-1-11-0-1-1-1"> Release [1.11.0.1.1.1] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id82"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id83"> What’s new in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id84"> Known Issues and Limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id85"> Convolution is not supported </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id86"> Number of data parallel training workers on one Trn1 instance </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id87"> Drop-out rate ignored in dropout operation </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id88"> Runtime error “invalid offset in Coalesced_memloc_…” followed by “Failed to process dma block: 1703” </a> </li> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#id89"> Compilation error: “TongaSBTensor[0x7fb2a46e0830]:TongaSB partitions[0] uint8 %138392[128, 512]” </a> </li> </ul> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-torch-neuronx-release-notes"> <span id="torch-neuronx-rn"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) release notes<a class="headerlink" href="#pytorch-neuron-torch-neuronx-release-notes" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#release-1-13-1-1-11-0" id="id90">Release [1.13.1.1.11.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-13-1-1-10-1" id="id91">Release [1.13.1.1.10.1]</a></p></li> <li><p><a class="reference internal" href="#release-1-13-1-1-10-0" id="id92">Release [1.13.1.1.10.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-13-1-1-9-0" id="id93">Release [1.13.1.1.9.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-13-1-1-8-0" id="id94">Release [1.13.1.1.8.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-13-1-1-7-0" id="id95">Release [1.13.1.1.7.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-13-0-1-6-1" id="id96">Release [1.13.0.1.6.1]</a></p></li> <li><p><a class="reference internal" href="#id39" id="id97">Release [1.13.0.1.6.1]</a></p></li> <li><p><a class="reference internal" href="#release-1-13-0-1-6-0" id="id98">Release [1.13.0.1.6.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-13-0-1-5-0" id="id99">Release [1.13.0.1.5.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-13-0-1-4-0" id="id100">Release [1.13.0.1.4.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-12-0-1-4-0" id="id101">Release [1.12.0.1.4.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-11-0-1-2-0" id="id102">Release [1.11.0.1.2.0]</a></p></li> <li><p><a class="reference internal" href="#release-1-11-0-1-1-1" id="id103">Release [1.11.0.1.1.1]</a></p></li> </ul> </div> <p>PyTorch Neuron for <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html#aws-trn1-arch"><span class="std std-ref">Trn1</span></a>/<a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html#aws-inf2-arch"><span class="std std-ref">Inf2</span></a> is a software package that enables PyTorch users to train, evaluate, and perform inference on second-generation Neuron hardware (See: <a class="reference internal" href="../../../general/arch/neuron-hardware/neuron-core-v2.html#neuroncores-v2-arch"><span class="std std-ref">NeuronCore-v2</span></a>).</p> <div class="section" id="release-1-13-1-1-11-0"> <h2><a class="toc-backref" href="#id90">Release [1.13.1.1.11.0]</a><a class="headerlink" href="#release-1-13-1-1-11-0" title="Permalink to this headline">#</a></h2> <p>Date: 9/15/2023</p> <div class="section" id="summary"> <h3>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="resolved-issues"> <h3>Resolved Issues<a class="headerlink" href="#resolved-issues" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fixed an issue in <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html#torch_neuronx.analyze" title="torch_neuronx.analyze"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.analyze()</span></code></a> which could cause failures with scalar inputs.</p></li> <li><p>Improved performance of <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html#torch_neuronx.analyze" title="torch_neuronx.analyze"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.analyze()</span></code></a>.</p></li> </ul> </div> </div> <div class="section" id="release-1-13-1-1-10-1"> <h2><a class="toc-backref" href="#id91">Release [1.13.1.1.10.1]</a><a class="headerlink" href="#release-1-13-1-1-10-1" title="Permalink to this headline">#</a></h2> <p>Date: 9/01/2023</p> <div class="section" id="id1"> <h3>Summary<a class="headerlink" href="#id1" title="Permalink to this headline">#</a></h3> <p>Minor bug fixes and enhancements.</p> </div> </div> <div class="section" id="release-1-13-1-1-10-0"> <h2><a class="toc-backref" href="#id92">Release [1.13.1.1.10.0]</a><a class="headerlink" href="#release-1-13-1-1-10-0" title="Permalink to this headline">#</a></h2> <p>Date: 8/28/2023</p> <div class="section" id="id2"> <h3>Summary<a class="headerlink" href="#id2" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="what-s-new-in-this-release"> <h3>What’s new in this release<a class="headerlink" href="#what-s-new-in-this-release" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Removed support for Python 3.7</p></li> <li><p>(Training) Added a neuron_parallel_compile command to clear file locks left behind when a neuron_parallel_compile execution was interrupted (neuron_parallel_compile –command clear-locks)</p></li> <li><p>(Training) Seedable dropout now enabled by default</p></li> </ul> </div> <div class="section" id="id3"> <h3>Resolved Issues<a class="headerlink" href="#id3" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>(Training) Convolution is now supported</p></li> <li><p>Fixed segmentation fault when using torch-neuronx to compile models on U22</p></li> <li><p>Fixed XLA tensor stride information in torch-xla package, which blocked lowering of log_softmax and similar functions which show errors like:</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">File</span> <span class="s2">"/home/ubuntu/waldronn/asr/test_env/lib/python3.7/site-packages/torch/nn/functional.py"</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1930</span><span class="p">,</span> <span class="ow">in</span> <span class="n">log_softmax</span> <span class="n">ret</span> <span class="o">=</span> <span class="nb">input</span><span class="o">.</span><span class="n">log_softmax</span><span class="p">(</span><span class="n">dim</span><span class="p">)</span> <span class="ne">RuntimeError</span><span class="p">:</span> <span class="n">dimensionality</span> <span class="n">of</span> <span class="n">sizes</span> <span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="n">must</span> <span class="n">match</span> <span class="n">dimensionality</span> <span class="n">of</span> <span class="n">strides</span> <span class="p">(</span><span class="mi">1</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="known-issues-and-limitations-training"> <h3>Known Issues and Limitations (Training)<a class="headerlink" href="#known-issues-and-limitations-training" title="Permalink to this headline">#</a></h3> <div class="section" id="memory-leaking-in-glibc"> <h4>Memory leaking in <code class="docutils literal notranslate"><span class="pre">glibc</span></code><a class="headerlink" href="#memory-leaking-in-glibc" title="Permalink to this headline">#</a></h4> <p><code class="docutils literal notranslate"><span class="pre">glibc</span></code> malloc memory leaks affect Neuron and may be temporarily limited by setting <code class="docutils literal notranslate"><span class="pre">MALLOC_ARENA_MAX</span></code>.</p> </div> <div class="section" id="ddp-shows-slow-convergence"> <h4>DDP shows slow convergence<a class="headerlink" href="#ddp-shows-slow-convergence" title="Permalink to this headline">#</a></h4> <p>Currently we see that the models converge slowly with DDP when compared to the scripts that don’t use DDP. We also see a throughput drop with DDP. This is a known issue with torch-xla: <a class="reference external" href="https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data">https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data</a></p> </div> <div class="section" id="runtime-crash-when-we-use-too-many-workers-per-node-with-ddp"> <h4>Runtime crash when we use too many workers per node with DDP<a class="headerlink" href="#runtime-crash-when-we-use-too-many-workers-per-node-with-ddp" title="Permalink to this headline">#</a></h4> <p>Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files``. </pre></div> </div> <p>Hence, it is recommended to use fewer workers per node with DDP.</p> </div> </div> <div class="section" id="known-issues-and-limitations-inference"> <h3>Known Issues and Limitations (Inference)<a class="headerlink" href="#known-issues-and-limitations-inference" title="Permalink to this headline">#</a></h3> <div class="section" id="torch-argmin-produces-incorrect-results"> <h4><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> produces incorrect results<a class="headerlink" href="#torch-argmin-produces-incorrect-results" title="Permalink to this headline">#</a></h4> <p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> produces incorrect results.</p> </div> <div class="section" id="no-automatic-partitioning"> <h4>No automatic partitioning<a class="headerlink" href="#no-automatic-partitioning" title="Permalink to this headline">#</a></h4> <p>Currently, when Neuron encounters an operation that it does not support during <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>, it may exit with the following compiler error: “Import of the HLO graph into the Neuron Compiler has failed. This may be caused by unsupported operators or an internal compiler error.” The intended behavior when tracing is to automatically partition the model into separate subgraphs that run on NeuronCores and subgraphs that run on CPU. This will be supported in a future release. See <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators"><span class="std std-ref">PyTorch Neuron (torch-neuronx) - Supported Operators</span></a> for a list of supported operators.</p> </div> <div class="section" id="torchscript-serialization-error-with-compiled-artifacts-larger-than-4gb"> <h4>Torchscript serialization error with compiled artifacts larger than 4GB<a class="headerlink" href="#torchscript-serialization-error-with-compiled-artifacts-larger-than-4gb" title="Permalink to this headline">#</a></h4> <p>When using <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>, compiled artifacts which exceed 4GB cannot be serialized. Serializing the torchscript artifact will trigger a segfault. This issue is resolved in torch but is not yet released: <a class="reference external" href="https://github.com/pytorch/pytorch/pull/99104">https://github.com/pytorch/pytorch/pull/99104</a></p> </div> </div> </div> <div class="section" id="release-1-13-1-1-9-0"> <h2><a class="toc-backref" href="#id93">Release [1.13.1.1.9.0]</a><a class="headerlink" href="#release-1-13-1-1-9-0" title="Permalink to this headline">#</a></h2> <p>Date: 7/19/2023</p> <div class="section" id="id4"> <h3>Summary<a class="headerlink" href="#id4" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="id5"> <h3>What’s new in this release<a class="headerlink" href="#id5" title="Permalink to this headline">#</a></h3> <p>Training support:</p> <ul class="simple"> <li><p>Uses jemalloc as the primary malloc lib to avoid memory leak at checkpointing</p></li> <li><p>Added support for ZeRO-1 along with <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html#zero1-gpt2-pretraining-tutorial"><span class="std std-ref">tutorial</span></a></p></li> </ul> <p>Inference support:</p> <ul class="simple"> <li><p>Add async load and lazy model load options to accelerate model loading</p></li> <li><p>Optimize DataParallel API to load onto multiple cores simultaneously when device IDs specified in device_ids are consecutive</p></li> </ul> </div> <div class="section" id="resolved-issues-training"> <h3>Resolved Issues (Training)<a class="headerlink" href="#resolved-issues-training" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Remove extra graph creation in torch_neuronx.optim.adamw when the beta/lr parameters values become 0 or 1.</p></li> <li><p>Stability improvements and faster failure on hitting a fault in XRT server used by XLA.</p></li> </ul> </div> <div class="section" id="id6"> <h3>Known Issues and Limitations (Training)<a class="headerlink" href="#id6" title="Permalink to this headline">#</a></h3> <div class="section" id="id7"> <h4>Memory leaking in <code class="docutils literal notranslate"><span class="pre">glibc</span></code><a class="headerlink" href="#id7" title="Permalink to this headline">#</a></h4> <p><code class="docutils literal notranslate"><span class="pre">glibc</span></code> malloc memory leaks affect Neuron and may be temporarily limited by setting <code class="docutils literal notranslate"><span class="pre">MALLOC_ARENA_MAX</span></code>.</p> </div> <div class="section" id="convolution-is-not-supported"> <h4>Convolution is not supported<a class="headerlink" href="#convolution-is-not-supported" title="Permalink to this headline">#</a></h4> <p>Convolution is not supported during training.</p> </div> <div class="section" id="id8"> <h4>DDP shows slow convergence<a class="headerlink" href="#id8" title="Permalink to this headline">#</a></h4> <p>Currently we see that the models converge slowly with DDP when compared to the scripts that don’t use DDP. We also see a throughput drop with DDP. This is a known issue with torch-xla: <a class="reference external" href="https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data">https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data</a></p> </div> <div class="section" id="id9"> <h4>Runtime crash when we use too many workers per node with DDP<a class="headerlink" href="#id9" title="Permalink to this headline">#</a></h4> <p>Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files``. </pre></div> </div> <p>Hence, it is recommended to use fewer workers per node with DDP.</p> </div> </div> <div class="section" id="id10"> <h3>Known Issues and Limitations (Inference)<a class="headerlink" href="#id10" title="Permalink to this headline">#</a></h3> <div class="section" id="id11"> <h4><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> produces incorrect results<a class="headerlink" href="#id11" title="Permalink to this headline">#</a></h4> <p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> produces incorrect results.</p> </div> <div class="section" id="id12"> <h4>No automatic partitioning<a class="headerlink" href="#id12" title="Permalink to this headline">#</a></h4> <p>Currently, when Neuron encounters an operation that it does not support during <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>, it may exit with the following compiler error: “Import of the HLO graph into the Neuron Compiler has failed. This may be caused by unsupported operators or an internal compiler error.” The intended behavior when tracing is to automatically partition the model into separate subgraphs that run on NeuronCores and subgraphs that run on CPU. This will be supported in a future release. See <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators"><span class="std std-ref">PyTorch Neuron (torch-neuronx) - Supported Operators</span></a> for a list of supported operators.</p> </div> <div class="section" id="id13"> <h4>Torchscript serialization error with compiled artifacts larger than 4GB<a class="headerlink" href="#id13" title="Permalink to this headline">#</a></h4> <p>When using <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>, compiled artifacts which exceed 4GB cannot be serialized. Serializing the torchscript artifact will trigger a segfault. This issue is resolved in torch but is not yet released: <a class="reference external" href="https://github.com/pytorch/pytorch/pull/99104">https://github.com/pytorch/pytorch/pull/99104</a></p> </div> </div> </div> <div class="section" id="release-1-13-1-1-8-0"> <h2><a class="toc-backref" href="#id94">Release [1.13.1.1.8.0]</a><a class="headerlink" href="#release-1-13-1-1-8-0" title="Permalink to this headline">#</a></h2> <p>Date: 6/14/2023</p> <div class="section" id="id14"> <h3>Summary<a class="headerlink" href="#id14" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added s3 caching to NeuronCache.</p></li> <li><p>Added extract/compile/analyze phases to neuron_parallel_compile.</p></li> </ul> </div> <div class="section" id="id15"> <h3>What’s new in this release<a class="headerlink" href="#id15" title="Permalink to this headline">#</a></h3> <p>Training support:</p> <ul class="simple"> <li><p>Added S3 caching support to NeuronCache. Removed NeuronCache options –cache_size/cache_ttl (please delete cache directories as needed).</p></li> <li><p>Added separate extract and compile phases Neuron Parallel Compile.</p></li> <li><p>Added model analyze API to Neuron Parallel Compile.</p></li> </ul> </div> <div class="section" id="id16"> <h3>Known Issues and Limitations (Training)<a class="headerlink" href="#id16" title="Permalink to this headline">#</a></h3> <div class="section" id="id17"> <h4>Memory leaking in <code class="docutils literal notranslate"><span class="pre">glibc</span></code><a class="headerlink" href="#id17" title="Permalink to this headline">#</a></h4> <p><code class="docutils literal notranslate"><span class="pre">glibc</span></code> malloc memory leaks affect Neuron and may be temporarily limited by setting <code class="docutils literal notranslate"><span class="pre">MALLOC_ARENA_MAX</span></code>.</p> </div> <div class="section" id="id18"> <h4>Convolution is not supported<a class="headerlink" href="#id18" title="Permalink to this headline">#</a></h4> <p>Convolution is not supported during training.</p> </div> <div class="section" id="id19"> <h4>DDP shows slow convergence<a class="headerlink" href="#id19" title="Permalink to this headline">#</a></h4> <p>Currently we see that the models converge slowly with DDP when compared to the scripts that don’t use DDP. We also see a throughput drop with DDP. This is a known issue with torch-xla: <a class="reference external" href="https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data">https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data</a></p> </div> <div class="section" id="id20"> <h4>Runtime crash when we use too many workers per node with DDP<a class="headerlink" href="#id20" title="Permalink to this headline">#</a></h4> <p>Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files``. </pre></div> </div> <p>Hence, it is recommended to use fewer workers per node with DDP.</p> </div> </div> <div class="section" id="id21"> <h3>Known Issues and Limitations (Inference)<a class="headerlink" href="#id21" title="Permalink to this headline">#</a></h3> <div class="section" id="id22"> <h4><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> produces incorrect results<a class="headerlink" href="#id22" title="Permalink to this headline">#</a></h4> <p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> produces incorrect results.</p> </div> <div class="section" id="id23"> <h4>No automatic partitioning<a class="headerlink" href="#id23" title="Permalink to this headline">#</a></h4> <p>Currently, when Neuron encounters an operation that it does not support during <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>, this will cause an error. The intended behavior when tracing is to automatically partition the model into separate subgraphs that run on NeuronCores and subgraphs that run on CPU. See <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators"><span class="std std-ref">PyTorch Neuron (torch-neuronx) - Supported Operators</span></a> for a list of supported operators.</p> </div> <div class="section" id="id24"> <h4>Torchscript serialization error with compiled artifacts larger than 4GB<a class="headerlink" href="#id24" title="Permalink to this headline">#</a></h4> <p>When using <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>, compiled artifacts which exceed 4GB cannot be serialized. Serializing the torchscript artifact will trigger a segfault. This issue is resolved in torch but is not yet released: <a class="reference external" href="https://github.com/pytorch/pytorch/pull/99104">https://github.com/pytorch/pytorch/pull/99104</a></p> </div> </div> </div> <div class="section" id="release-1-13-1-1-7-0"> <h2><a class="toc-backref" href="#id95">Release [1.13.1.1.7.0]</a><a class="headerlink" href="#release-1-13-1-1-7-0" title="Permalink to this headline">#</a></h2> <p>Date: 05/01/2023</p> <div class="section" id="id25"> <h3>Summary<a class="headerlink" href="#id25" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="id26"> <h3>What’s new in this release<a class="headerlink" href="#id26" title="Permalink to this headline">#</a></h3> <p>Training support:</p> <ul class="simple"> <li><p>Added an improved Neuron-optimized AdamW optimizer implementation.</p></li> <li><p>Added an improved Neuron-optimized <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Dropout.html#torch.nn.Dropout" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.Dropout</span></code></a> implementation.</p></li> <li><p>Added an assertion when the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Dropout.html#torch.nn.Dropout" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.Dropout</span></code></a> argument <code class="docutils literal notranslate"><span class="pre">inplace=True</span></code> during training. This is currently not supported on Neuron.</p></li> <li><p>Added XLA lowering for <code class="docutils literal notranslate"><span class="pre">aten::count_nonzero</span></code></p></li> </ul> <p>Inference support:</p> <ul class="simple"> <li><p>Added profiling support for models compiled with <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a></p></li> <li><p>Added torch_neuronx.DataParallel for models compiled with <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a></p></li> </ul> </div> <div class="section" id="id27"> <h3>Resolved Issues (Training)<a class="headerlink" href="#id27" title="Permalink to this headline">#</a></h3> <div class="section" id="unexpected-behavior-with-torch-autocast"> <h4>Unexpected behavior with <a class="reference external" href="https://pytorch.org/docs/master/amp.html#torch.autocast" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.autocast</span></code></a><a class="headerlink" href="#unexpected-behavior-with-torch-autocast" title="Permalink to this headline">#</a></h4> <p>Fixed an issue where <a class="reference external" href="https://pytorch.org/docs/master/amp.html#torch.autocast" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.autocast</span></code></a> did not correctly autocast when using <code class="docutils literal notranslate"><span class="pre">torch.bfloat16</span></code></p> </div> <div class="section" id="resolved-slower-bert-bf16-phase-1-single-node-performance"> <h4>Resolved slower BERT bf16 Phase 1 Single Node Performance<a class="headerlink" href="#resolved-slower-bert-bf16-phase-1-single-node-performance" title="Permalink to this headline">#</a></h4> <p>As of the Neuron 2.9.0 release, <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html#hf-bert-pretraining-tutorial"><span class="std std-ref">BERT phase 1 pretraining</span></a> performance has regressed by approximately 8-9% when executed on a <em>single node</em> only (i.e. just one <code class="docutils literal notranslate"><span class="pre">trn1.32xlarge</span></code> instance). This is resolved in 2.10 release.</p> </div> <div class="section" id="resolved-lower-throughput-for-bert-large-training-on-al2-instances"> <h4>Resolved lower throughput for BERT-large training on AL2 instances<a class="headerlink" href="#resolved-lower-throughput-for-bert-large-training-on-al2-instances" title="Permalink to this headline">#</a></h4> <p>Starting in release 2.7, we see a performance drop of roughly 5-10% for BERT model training on AL2 instances. This is resolved in release 2.10.</p> </div> </div> <div class="section" id="resolved-issues-inference"> <h3>Resolved Issues (Inference)<a class="headerlink" href="#resolved-issues-inference" title="Permalink to this headline">#</a></h3> <div class="section" id="error-when-using-the-original-model-after-torch-neuronx-trace"> <h4>Error when using the original model after <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace</span></code><a class="headerlink" href="#error-when-using-the-original-model-after-torch-neuronx-trace" title="Permalink to this headline">#</a></h4> <p>Fixed an issue where model parameters would be moved to the Neuron <code class="docutils literal notranslate"><span class="pre">'xla'</span></code> device during <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a> and would no longer be available to execute on the original device. This made it more difficult to compare Neuron models against CPU since previously this would require manually moving parameters back to CPU.</p> </div> <div class="section" id="error-when-using-the-xm-xla-device-object-followed-by-using-torch-neuronx-trace"> <h4>Error when using the <code class="docutils literal notranslate"><span class="pre">xm.xla_device()</span></code> object followed by using <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace</span></code><a class="headerlink" href="#error-when-using-the-xm-xla-device-object-followed-by-using-torch-neuronx-trace" title="Permalink to this headline">#</a></h4> <p>Fixed an issue where XLA device execution and <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a> could not be performed in the same python process.</p> </div> <div class="section" id="error-when-executing-torch-neuronx-trace-with-torch-bfloat16-input-output-tensors"> <h4>Error when executing <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace</span></code> with <code class="docutils literal notranslate"><span class="pre">torch.bfloat16</span></code> input/output tensors<a class="headerlink" href="#error-when-executing-torch-neuronx-trace-with-torch-bfloat16-input-output-tensors" title="Permalink to this headline">#</a></h4> <p>Fixed an issue where <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a> could not compile models which consumed or produced <code class="docutils literal notranslate"><span class="pre">torch.bfloat16</span></code> values.</p> </div> </div> <div class="section" id="id28"> <h3>Known Issues and Limitations (Training)<a class="headerlink" href="#id28" title="Permalink to this headline">#</a></h3> <div class="section" id="id29"> <h4>Memory leaking in <code class="docutils literal notranslate"><span class="pre">glibc</span></code><a class="headerlink" href="#id29" title="Permalink to this headline">#</a></h4> <p><code class="docutils literal notranslate"><span class="pre">glibc</span></code> malloc memory leaks affect Neuron and may be temporarily limited by setting <code class="docutils literal notranslate"><span class="pre">MALLOC_ARENA_MAX</span></code>.</p> </div> <div class="section" id="id30"> <h4>Convolution is not supported<a class="headerlink" href="#id30" title="Permalink to this headline">#</a></h4> <p>Convolution is not supported during training.</p> </div> <div class="section" id="id31"> <h4>DDP shows slow convergence<a class="headerlink" href="#id31" title="Permalink to this headline">#</a></h4> <p>Currently we see that the models converge slowly with DDP when compared to the scripts that don’t use DDP. We also see a throughput drop with DDP. This is a known issue with torch-xla: <a class="reference external" href="https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data">https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data</a></p> </div> <div class="section" id="id32"> <h4>Runtime crash when we use too many workers per node with DDP<a class="headerlink" href="#id32" title="Permalink to this headline">#</a></h4> <p>Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>bootstrap.cc:86 CCOM WARN Call to accept failed : Too many open files``. </pre></div> </div> <p>Hence, it is recommended to use fewer workers per node with DDP.</p> </div> </div> <div class="section" id="id33"> <h3>Known Issues and Limitations (Inference)<a class="headerlink" href="#id33" title="Permalink to this headline">#</a></h3> <div class="section" id="id34"> <h4><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> produces incorrect results<a class="headerlink" href="#id34" title="Permalink to this headline">#</a></h4> <p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> produces incorrect results.</p> </div> <div class="section" id="id35"> <h4>No automatic partitioning<a class="headerlink" href="#id35" title="Permalink to this headline">#</a></h4> <p>Currently, when Neuron encounters an operation that it does not support during <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>, this will cause an error. The intended behavior when tracing is to automatically partition the model into separate subgraphs that run on NeuronCores and subgraphs that run on CPU. See <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators"><span class="std std-ref">PyTorch Neuron (torch-neuronx) - Supported Operators</span></a> for a list of supported operators.</p> </div> <div class="section" id="id36"> <h4>Torchscript serialization error with compiled artifacts larger than 4GB<a class="headerlink" href="#id36" title="Permalink to this headline">#</a></h4> <p>When using <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a>, compiled artifacts which exceed 4GB cannot be serialized. Serializing the torchscript artifact will trigger a segfault. This issue is resolved in torch but is not yet released: <a class="reference external" href="https://github.com/pytorch/pytorch/pull/99104">https://github.com/pytorch/pytorch/pull/99104</a></p> </div> </div> </div> <div class="section" id="release-1-13-0-1-6-1"> <h2><a class="toc-backref" href="#id96">Release [1.13.0.1.6.1]</a><a class="headerlink" href="#release-1-13-0-1-6-1" title="Permalink to this headline">#</a></h2> <p>Date: 04/19/2023</p> <div class="section" id="id37"> <h3>Summary<a class="headerlink" href="#id37" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="id38"> <h3>What’s new in this release<a class="headerlink" href="#id38" title="Permalink to this headline">#</a></h3> <p>Training support:</p> <ul class="simple"> <li><p>No changes</p></li> </ul> <p>Inference support:</p> <ul class="simple"> <li><p>Enable deserialized TorchScript modules to be compiled with <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a></p></li> </ul> </div> </div> <div class="section" id="id39"> <h2><a class="toc-backref" href="#id97">Release [1.13.0.1.6.1]</a><a class="headerlink" href="#id39" title="Permalink to this headline">#</a></h2> <p>Date: 04/19/2023</p> <div class="section" id="id40"> <h3>Summary<a class="headerlink" href="#id40" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="id41"> <h3>What’s new in this release<a class="headerlink" href="#id41" title="Permalink to this headline">#</a></h3> <p>Training support:</p> <ul class="simple"> <li><p>No changes</p></li> </ul> <p>Inference support:</p> <ul class="simple"> <li><p>Enable deserialized TorchScript modules to be compiled with <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html#torch_neuronx.trace" title="torch_neuronx.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code></a></p></li> </ul> </div> </div> <div class="section" id="release-1-13-0-1-6-0"> <h2><a class="toc-backref" href="#id98">Release [1.13.0.1.6.0]</a><a class="headerlink" href="#release-1-13-0-1-6-0" title="Permalink to this headline">#</a></h2> <p>Date: 03/28/2023</p> <div class="section" id="id42"> <h3>Summary<a class="headerlink" href="#id42" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="id43"> <h3>What’s new in this release<a class="headerlink" href="#id43" title="Permalink to this headline">#</a></h3> <p>Training support:</p> <ul class="simple"> <li><p>Added pipeline parallelism support in AWS Samples for Megatron-LM</p></li> </ul> <p>Inference support:</p> <ul class="simple"> <li><p>Added model analysis API: torch_neuronx.analyze</p></li> <li><p>Added HLO opcode support for:</p> <ul> <li><p>kAtan2</p></li> <li><p>kAfterAll</p></li> <li><p>kMap</p></li> </ul> </li> <li><p>Added XLA lowering support for:</p> <ul> <li><p>aten::glu</p></li> <li><p>aten::scatter_reduce</p></li> </ul> </li> <li><p>Updated torch.nn.MSELoss to promote input data types to a compatible type</p></li> </ul> </div> <div class="section" id="id44"> <h3>Resolved Issues (Training)<a class="headerlink" href="#id44" title="Permalink to this headline">#</a></h3> <div class="section" id="grpc-timeout-errors-when-running-megatron-lm-gpt-6-7b-tutorial-on-multiple-instances"> <h4>GRPC timeout errors when running Megatron-LM GPT 6.7B tutorial on multiple instances<a class="headerlink" href="#grpc-timeout-errors-when-running-megatron-lm-gpt-6-7b-tutorial-on-multiple-instances" title="Permalink to this headline">#</a></h4> <p>When running AWS Samples for Megatron-LM GPT 6.7B tutorial over multiple instances, you may encounter GRPC timeout errors like below:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">E0302</span> <span class="mi">01</span><span class="p">:</span><span class="mi">10</span><span class="p">:</span><span class="mf">20.511231294</span> <span class="mi">138645</span> <span class="n">chttp2_transport</span><span class="o">.</span><span class="n">cc</span><span class="p">:</span><span class="mi">1098</span><span class="p">]</span> <span class="n">Received</span> <span class="n">a</span> <span class="n">GOAWAY</span> <span class="k">with</span> <span class="n">error</span> <span class="n">code</span> <span class="n">ENHANCE_YOUR_CALM</span> <span class="ow">and</span> <span class="n">debug</span> <span class="n">data</span> <span class="n">equal</span> <span class="n">to</span> <span class="s2">"too_many_pings"</span> <span class="mi">2023</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">02</span> <span class="mi">01</span><span class="p">:</span><span class="mi">10</span><span class="p">:</span><span class="mf">20.511500</span><span class="p">:</span> <span class="n">W</span> <span class="n">tensorflow</span><span class="o">/</span><span class="n">core</span><span class="o">/</span><span class="n">distributed_runtime</span><span class="o">/</span><span class="n">rpc</span><span class="o">/</span><span class="n">grpc_remote_master</span><span class="o">.</span><span class="n">cc</span><span class="p">:</span><span class="mi">157</span><span class="p">]</span> <span class="n">RPC</span> <span class="n">failed</span> <span class="k">with</span> <span class="n">status</span> <span class="o">=</span> <span class="s2">"UNAVAILABLE: Too many pings"</span> <span class="ow">and</span> <span class="n">grpc_error_string</span> <span class="o">=</span> <span class="s2">"{"</span><span class="n">created</span><span class="s2">":"</span><span class="o">@</span><span class="mf">1677719420.511317309</span><span class="s2">","</span><span class="n">description</span><span class="s2">":"</span><span class="n">Error</span> <span class="n">received</span> <span class="kn">from</span> <span class="nn">peer</span> <span class="n">ipv4</span><span class="p">:</span><span class="mf">10.1.35.105</span><span class="p">:</span><span class="mi">54729</span><span class="s2">","</span><span class="n">file</span><span class="s2">":"</span><span class="n">external</span><span class="o">/</span><span class="n">com_github_grpc_grpc</span><span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="n">core</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">surface</span><span class="o">/</span><span class="n">call</span><span class="o">.</span><span class="n">cc</span><span class="s2">","</span><span class="n">file_line</span><span class="s2">":1056,"</span><span class="n">grpc_message</span><span class="s2">":"</span><span class="n">Too</span> <span class="n">many</span> <span class="n">pings</span><span class="s2">","</span><span class="n">grpc_status</span><span class="s2">":14}"</span><span class="p">,</span> <span class="n">maybe</span> <span class="n">retrying</span> <span class="n">the</span> <span class="n">RPC</span> </pre></div> </div> <p>or:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">2023</span><span class="o">-</span><span class="mi">03</span><span class="o">-</span><span class="mi">08</span> <span class="mi">21</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mf">27.040863</span><span class="p">:</span> <span class="n">F</span> <span class="n">tensorflow</span><span class="o">/</span><span class="n">compiler</span><span class="o">/</span><span class="n">xla</span><span class="o">/</span><span class="n">xla_client</span><span class="o">/</span><span class="n">xrt_computation_client</span><span class="o">.</span><span class="n">cc</span><span class="p">:</span><span class="mi">476</span><span class="p">]</span> <span class="n">Non</span><span class="o">-</span><span class="n">OK</span><span class="o">-</span><span class="n">status</span><span class="p">:</span> <span class="n">session</span><span class="o">-&gt;</span><span class="n">session</span><span class="p">()</span><span class="o">-&gt;</span><span class="n">Run</span><span class="p">(</span><span class="n">session_work</span><span class="o">-&gt;</span><span class="n">feed_inputs</span><span class="p">,</span> <span class="n">session_work</span><span class="o">-&gt;</span><span class="n">outputs_handles</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">outputs</span><span class="p">)</span> <span class="n">status</span><span class="p">:</span> <span class="n">UNKNOWN</span><span class="p">:</span> <span class="n">Stream</span> <span class="n">removed</span> </pre></div> </div> <p>This is due to excessive DNS lookups during execution, and is fixed in this release.</p> </div> <div class="section" id="nans-seen-with-transformers-version-4-21-0-when-running-hf-gpt-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> <h4>NaNs seen with transformers version &gt;= 4.21.0 when running HF GPT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1<a class="headerlink" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-gpt-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1" title="Permalink to this headline">#</a></h4> <p>Using Hugging Face transformers version &gt;= 4.21.0 can produce NaN outputs for GPT models when using full BF16 (XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1) plus stochastic rounding. This issue occurs due to large negative constants used to implement attention masking (<a class="reference external" href="https://github.com/huggingface/transformers/pull/17306">https://github.com/huggingface/transformers/pull/17306</a>). To workaround this issue, please use transformers version &lt;= 4.20.0.</p> </div> </div> <div class="section" id="id45"> <h3>Resolved Issues (Inference)<a class="headerlink" href="#id45" title="Permalink to this headline">#</a></h3> <div class="section" id="torch-argmax-now-supports-single-argument-call-variant"> <h4><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmax.html#torch.argmax" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmax()</span></code></a> now supports single argument call variant<a class="headerlink" href="#torch-argmax-now-supports-single-argument-call-variant" title="Permalink to this headline">#</a></h4> <p>Previously only the 3 argument variant of <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmax.html#torch.argmax" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmax()</span></code></a> was supported. Now the single argument call variant is supported.</p> </div> </div> <div class="section" id="id46"> <h3>Known Issues and Limitations (Training)<a class="headerlink" href="#id46" title="Permalink to this headline">#</a></h3> <div class="section" id="slower-bert-bf16-phase-1-single-node-performance"> <h4>Slower BERT bf16 Phase 1 Single Node Performance<a class="headerlink" href="#slower-bert-bf16-phase-1-single-node-performance" title="Permalink to this headline">#</a></h4> <p>In the Neuron 2.9.0 release, <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html#hf-bert-pretraining-tutorial"><span class="std std-ref">BERT phase 1 pretraining</span></a> performance has regressed by approximately 8-9% when executed on a <em>single node</em> only (i.e. just one <code class="docutils literal notranslate"><span class="pre">trn1.32xlarge</span></code> instance).</p> </div> <div class="section" id="id47"> <h4>Convolution is not supported<a class="headerlink" href="#id47" title="Permalink to this headline">#</a></h4> <p>In this release, convolution is not supported.</p> </div> <div class="section" id="id48"> <h4>DDP shows slow convergence<a class="headerlink" href="#id48" title="Permalink to this headline">#</a></h4> <p>Currently we see that the models converge slowly with DDP when compared to the scripts that don’t use DDP. We also see a throughput drop with DDP. This is a known issue with torch-xla: <a class="reference external" href="https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data">https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data</a></p> </div> <div class="section" id="id49"> <h4>Runtime crash when we use too many workers per node with DDP<a class="headerlink" href="#id49" title="Permalink to this headline">#</a></h4> <p>Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: <code class="docutils literal notranslate"><span class="pre">bootstrap.cc:86</span> <span class="pre">CCOM</span> <span class="pre">WARN</span> <span class="pre">Call</span> <span class="pre">to</span> <span class="pre">accept</span> <span class="pre">failed</span> <span class="pre">:</span> <span class="pre">Too</span> <span class="pre">many</span> <span class="pre">open</span> <span class="pre">files</span></code>.</p> <p>Hence, it is recommended to use fewer workers per node with DDP.</p> </div> <div class="section" id="lower-throughput-for-bert-large-training-on-al2-instances"> <h4>Lower throughput for BERT-large training on AL2 instances<a class="headerlink" href="#lower-throughput-for-bert-large-training-on-al2-instances" title="Permalink to this headline">#</a></h4> <p>We see a performance drop of roughly 5-10% for BERT model training on AL2 instances. This is because of the increase in time required for tracing the model.</p> </div> </div> <div class="section" id="id50"> <h3>Known Issues and Limitations (Inference)<a class="headerlink" href="#id50" title="Permalink to this headline">#</a></h3> <div class="section" id="id51"> <h4><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> produces incorrect results<a class="headerlink" href="#id51" title="Permalink to this headline">#</a></h4> <p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> now supports both the single argument call variant and the 3 argument variant. However, <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> currently produces incorrect results.</p> </div> <div class="section" id="id52"> <h4>Error when using the <code class="docutils literal notranslate"><span class="pre">xm.xla_device()</span></code> object followed by using <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace</span></code><a class="headerlink" href="#id52" title="Permalink to this headline">#</a></h4> <p>Executing a model using the <code class="docutils literal notranslate"><span class="pre">xm.xla_device()</span></code> object followed by using <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace</span></code> in the same process can produce errors in specific situations due to torch-xla caching behavior. It is recommended that only one type of execution is used per process.</p> </div> <div class="section" id="id53"> <h4>Error when executing <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace</span></code> with <code class="docutils literal notranslate"><span class="pre">torch.bfloat16</span></code> input/output tensors<a class="headerlink" href="#id53" title="Permalink to this headline">#</a></h4> <p>Executing <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace</span></code> with <code class="docutils literal notranslate"><span class="pre">torch.bfloat16</span></code> input/output tensors can cause an error. It is currently recommended to use an alternative torch data type in combination with compiler casting flags instead.</p> </div> <div class="section" id="id54"> <h4>No automatic partitioning<a class="headerlink" href="#id54" title="Permalink to this headline">#</a></h4> <p>Currently, there’s no automatic partitioning of a model into subgraphs that run on NeuronCores and subgraphs that run on CPU Operations in the model that are not supported by Neuron would result in compilation error. Please see <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators"><span class="std std-ref">PyTorch Neuron (torch-neuronx) - Supported Operators</span></a> for a list of supported operators.</p> </div> </div> </div> <div class="section" id="release-1-13-0-1-5-0"> <h2><a class="toc-backref" href="#id99">Release [1.13.0.1.5.0]</a><a class="headerlink" href="#release-1-13-0-1-5-0" title="Permalink to this headline">#</a></h2> <p>Date: 02/24/2023</p> <div class="section" id="id55"> <h3>Summary<a class="headerlink" href="#id55" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="id56"> <h3>What’s new in this release<a class="headerlink" href="#id56" title="Permalink to this headline">#</a></h3> <p>Training support:</p> <ul class="simple"> <li><p>Added SPMD flag for XLA backend to generate global collective-compute replica groups</p></li> </ul> <p>Inference support:</p> <ul class="simple"> <li><p>Expanded inference support to inf2</p></li> <li><p>Added Dynamic Batching</p></li> </ul> </div> <div class="section" id="id57"> <h3>Resolved Issues<a class="headerlink" href="#id57" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="id58"> <h3>Known Issues and Limitations (Training)<a class="headerlink" href="#id58" title="Permalink to this headline">#</a></h3> <div class="section" id="id59"> <h4>Convolution is not supported<a class="headerlink" href="#id59" title="Permalink to this headline">#</a></h4> <p>In this release, convolution is not supported.</p> </div> <div class="section" id="id60"> <h4>DDP shows slow convergence<a class="headerlink" href="#id60" title="Permalink to this headline">#</a></h4> <p>Currently we see that the models converge slowly with DDP when compared to the scripts that don’t use DDP. We also see a throughput drop with DDP. This is a known issue with torch-xla: <a class="reference external" href="https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data">https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data</a></p> </div> <div class="section" id="id61"> <h4>Runtime crash when we use too many workers per node with DDP<a class="headerlink" href="#id61" title="Permalink to this headline">#</a></h4> <p>Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: <code class="docutils literal notranslate"><span class="pre">bootstrap.cc:86</span> <span class="pre">CCOM</span> <span class="pre">WARN</span> <span class="pre">Call</span> <span class="pre">to</span> <span class="pre">accept</span> <span class="pre">failed</span> <span class="pre">:</span> <span class="pre">Too</span> <span class="pre">many</span> <span class="pre">open</span> <span class="pre">files</span></code>.</p> <p>Hence, it is recommended to use fewer workers per node with DDP.</p> </div> <div class="section" id="id62"> <h4>Lower throughput for BERT-large training on AL2 instances<a class="headerlink" href="#id62" title="Permalink to this headline">#</a></h4> <p>We see a performance drop of roughly 5-10% for BERT model training on AL2 instances. This is because of the increase in time required for tracing the model.</p> </div> </div> <div class="section" id="id63"> <h3>Known Issues and Limitations (Inference)<a class="headerlink" href="#id63" title="Permalink to this headline">#</a></h3> <div class="section" id="torch-argmax-and-torch-argmin-do-not-support-the-single-argument-call-variant"> <h4><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmax.html#torch.argmax" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmax()</span></code></a> and <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> do not support the single argument call variant<a class="headerlink" href="#torch-argmax-and-torch-argmin-do-not-support-the-single-argument-call-variant" title="Permalink to this headline">#</a></h4> <p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmax.html#torch.argmax" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmax()</span></code></a> and <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> do not support the single argument call variant. Only the 3 argument variant of these functions is supported. The <code class="docutils literal notranslate"><span class="pre">dim</span></code> argument <em>must be</em> specified or this function will fail at the call-site. Secondly, <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.argmin.html#torch.argmin" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.argmin()</span></code></a> may produce incorrect results.</p> </div> <div class="section" id="id64"> <h4>No automatic partitioning<a class="headerlink" href="#id64" title="Permalink to this headline">#</a></h4> <p>Currently, there’s no automatic partitioning of a model into subgraphs that run on NeuronCores and subgraphs that run on CPU Operations in the model that are not supported by Neuron would result in compilation error. Please see <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators"><span class="std std-ref">PyTorch Neuron (torch-neuronx) - Supported Operators</span></a> for a list of supported operators.</p> </div> </div> </div> <div class="section" id="release-1-13-0-1-4-0"> <h2><a class="toc-backref" href="#id100">Release [1.13.0.1.4.0]</a><a class="headerlink" href="#release-1-13-0-1-4-0" title="Permalink to this headline">#</a></h2> <p>Date: 02/08/2023</p> <div class="section" id="id65"> <h3>Summary<a class="headerlink" href="#id65" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="id66"> <h3>What’s new in this release<a class="headerlink" href="#id66" title="Permalink to this headline">#</a></h3> <p>Training support:</p> <ul class="simple"> <li><p>Added support for PyTorch 1.13</p></li> <li><p>Added support for Python version 3.9</p></li> <li><p>Added support for torch.nn.parallel.DistributedDataParallel (DDP) along with a <span class="xref std std-ref">tutorial</span></p></li> <li><p>Added optimized lowering for Softmax activation</p></li> <li><p>Added support for LAMB optimizer in BF16 mode</p></li> </ul> <p>Added initial support for inference on Trn1, including the following features:</p> <ul class="simple"> <li><p>Trace API (torch_neuronx.trace)</p></li> <li><p>Core placement API (experimental)</p></li> <li><p>Python 3.7, 3.8 and 3.9 support</p></li> <li><p>Support for tracing models larger than 2 GB</p></li> </ul> <p>The following inference features are not included in this release:</p> <ul class="simple"> <li><p>Automatic partitioning of a model into subgraphs that run on NeuronCores and subgraphs that run on CPU</p></li> <li><p>cxx11 ABI wheels</p></li> </ul> </div> <div class="section" id="id67"> <h3>Resolved Issues<a class="headerlink" href="#id67" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="known-issues-and-limitations"> <h3>Known Issues and Limitations<a class="headerlink" href="#known-issues-and-limitations" title="Permalink to this headline">#</a></h3> <div class="section" id="id68"> <h4>Convolution is not supported<a class="headerlink" href="#id68" title="Permalink to this headline">#</a></h4> <p>In this release, convolution is not supported.</p> </div> <div class="section" id="id69"> <h4>DDP shows slow convergence<a class="headerlink" href="#id69" title="Permalink to this headline">#</a></h4> <p>Currently we see that the models converge slowly with DDP when compared to the scripts that don’t use DDP. We also see a throughput drop with DDP. This is a known issue with torch-xla: <a class="reference external" href="https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data">https://pytorch.org/xla/release/1.13/index.html#mnist-with-real-data</a></p> </div> <div class="section" id="id70"> <h4>Runtime crash when we use too many workers per node with DDP<a class="headerlink" href="#id70" title="Permalink to this headline">#</a></h4> <p>Currently, if we use 32 workers with DDP, we see that each worker generates its own graph. This causes an error in the runtime, and you may see errors that look like this: <code class="docutils literal notranslate"><span class="pre">bootstrap.cc:86</span> <span class="pre">CCOM</span> <span class="pre">WARN</span> <span class="pre">Call</span> <span class="pre">to</span> <span class="pre">accept</span> <span class="pre">failed</span> <span class="pre">:</span> <span class="pre">Too</span> <span class="pre">many</span> <span class="pre">open</span> <span class="pre">files</span></code>.</p> <p>Hence, it is recommended to use fewer workers per node with DDP.</p> </div> <div class="section" id="id71"> <h4>Lower throughput for BERT-large training on AL2 instances<a class="headerlink" href="#id71" title="Permalink to this headline">#</a></h4> <p>We see a performance drop of roughly 5-10% for BERT model training on AL2 instances. This is because of the increase in time required for tracing the model.</p> </div> </div> </div> <div class="section" id="release-1-12-0-1-4-0"> <h2><a class="toc-backref" href="#id101">Release [1.12.0.1.4.0]</a><a class="headerlink" href="#release-1-12-0-1-4-0" title="Permalink to this headline">#</a></h2> <p>Date: 12/12/2022</p> <div class="section" id="id72"> <h3>Summary<a class="headerlink" href="#id72" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="whats-new-in-this-release"> <h3>What’s new in this release<a class="headerlink" href="#whats-new-in-this-release" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added support for PyTorch 1.12.</p></li> <li><p>Setting XLA_DOWNCAST_BF16=1 now also enables stochastic rounding by default (as done with XLA_USE_BF16=1).</p></li> <li><p>Added support for <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html#torch-neuronx-snapshotting"><span class="std std-ref">capturing snapshots</span></a> of inputs, outputs and graph HLO for debug.</p></li> <li><p>Fixed issue with parallel compile error when both train and evaluation are enabled in HuggingFace fine-tuning tutorial.</p></li> <li><p>Added support for LAMB optimizer in FP32 mode.</p></li> </ul> </div> <div class="section" id="id73"> <h3>Resolved Issues<a class="headerlink" href="#id73" title="Permalink to this headline">#</a></h3> <div class="section" id="nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> <h4>NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1<a class="headerlink" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1" title="Permalink to this headline">#</a></h4> <p>When running HuggingFace BERT (any size) fine-tuning tutorial or pretraining tutorial with transformers version &gt;= 4.21.0 and using XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1, you will see NaNs in the loss immediately at the first step. More details on the issue can be found at <a class="reference external" href="https://github.com/pytorch/xla/issues/4152">pytorch/xla#4152</a>. The workaround is to use 4.20.0 or earlier (the tutorials currently recommend version 4.15.0) or add the line <code class="docutils literal notranslate"><span class="pre">transformers.modeling_utils.get_parameter_dtype</span> <span class="pre">=</span> <span class="pre">lambda</span> <span class="pre">x:</span> <span class="pre">torch.bfloat16</span></code> to your Python training script (as now done in latest tutorials). <a class="reference external" href="https://github.com/huggingface/transformers/pull/20562">A permanent fix</a> will become part of an upcoming HuggingFace transformers release.</p> </div> </div> <div class="section" id="id74"> <h3>Known Issues and Limitations<a class="headerlink" href="#id74" title="Permalink to this headline">#</a></h3> <div class="section" id="id75"> <h4>Convolution is not supported<a class="headerlink" href="#id75" title="Permalink to this headline">#</a></h4> <p>In this release, convolution is not supported.</p> </div> <div class="section" id="number-of-data-parallel-training-workers-on-one-trn1-instance"> <h4>Number of data parallel training workers on one Trn1 instance<a class="headerlink" href="#number-of-data-parallel-training-workers-on-one-trn1-instance" title="Permalink to this headline">#</a></h4> <p>The number of workers used in single-instance data parallel training can be one of the following values: 1 or 2 for trn1.2xlarge and 1, 2, 8 or 32 for trn1.32xlarge.</p> </div> </div> </div> <div class="section" id="release-1-11-0-1-2-0"> <h2><a class="toc-backref" href="#id102">Release [1.11.0.1.2.0]</a><a class="headerlink" href="#release-1-11-0-1-2-0" title="Permalink to this headline">#</a></h2> <p>Date: 10/27/2022</p> <div class="section" id="id76"> <h3>Summary<a class="headerlink" href="#id76" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="id77"> <h3>What’s new in this release<a class="headerlink" href="#id77" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added support for argmax.</p></li> <li><p>Clarified error messages for runtime errors <code class="docutils literal notranslate"><span class="pre">NRT_UNINITIALIZED</span></code> and <code class="docutils literal notranslate"><span class="pre">NRT_CLOSED</span></code>.</p></li> <li><p>When multi-worker training is launched using torchrun on one instance, framework now handles runtime state cleanup at end of training.</p></li> </ul> </div> <div class="section" id="id78"> <h3>Resolved Issues<a class="headerlink" href="#id78" title="Permalink to this headline">#</a></h3> <div class="section" id="drop-out-rate-ignored-in-dropout-operation"> <h4>Drop-out rate ignored in dropout operation<a class="headerlink" href="#drop-out-rate-ignored-in-dropout-operation" title="Permalink to this headline">#</a></h4> <p>A known issue in the compiler’s implementation of dropout caused drop-rate to be ignored in the last release. It is fixed in the current release.</p> </div> <div class="section" id="runtime-error-invalid-offset-in-coalesced-memloc-followed-by-failed-to-process-dma-block-1703"> <h4>Runtime error “invalid offset in Coalesced_memloc_…” followed by “Failed to process dma block: 1703”<a class="headerlink" href="#runtime-error-invalid-offset-in-coalesced-memloc-followed-by-failed-to-process-dma-block-1703" title="Permalink to this headline">#</a></h4> <p>Previously, when running MRPC fine-tuning tutorial with <code class="docutils literal notranslate"><span class="pre">bert-base-*</span></code> model, you would encounter runtime error “invalid offset in Coalesced_memloc_…” followed by “Failed to process dma block: 1703”. This is fixed in the current release.</p> </div> <div class="section" id="compilation-error-tongasbtensor-0x7fb2a46e0830-tongasb-partitions-0-uint8-138392-128-512"> <h4>Compilation error: “TongaSBTensor[0x7fb2a46e0830]:TongaSB partitions[0] uint8 %138392[128, 512]”<a class="headerlink" href="#compilation-error-tongasbtensor-0x7fb2a46e0830-tongasb-partitions-0-uint8-138392-128-512" title="Permalink to this headline">#</a></h4> <p>Previously, when compiling MRPC fine-tuning tutorial with <code class="docutils literal notranslate"><span class="pre">bert-large-*</span></code> and FP32 (no XLA_USE_BF16=1) for two workers or more, you would encounter compiler error that looks like <code class="docutils literal notranslate"><span class="pre">Error</span> <span class="pre">message:</span>&nbsp; <span class="pre">TongaSBTensor[0x7fb2a46e0830]:TongaSB</span> <span class="pre">partitions[0]</span> <span class="pre">uint8</span> <span class="pre">%138392[128,</span> <span class="pre">512]</span></code> followed by <code class="docutils literal notranslate"><span class="pre">Error</span> <span class="pre">class:</span>&nbsp;&nbsp;&nbsp; <span class="pre">KeyError</span></code>. Single worker fine-tuning is not affected. This is fixed in the current release.</p> </div> </div> <div class="section" id="id79"> <h3>Known Issues and Limitations<a class="headerlink" href="#id79" title="Permalink to this headline">#</a></h3> <div class="section" id="id80"> <h4>Convolution is not supported<a class="headerlink" href="#id80" title="Permalink to this headline">#</a></h4> <p>In this release, convolution is not supported.</p> </div> <div class="section" id="id81"> <h4>Number of data parallel training workers on one Trn1 instance<a class="headerlink" href="#id81" title="Permalink to this headline">#</a></h4> <p>The number of workers used in single-instance data parallel training can be one of the following values: 1 or 2 for trn1.2xlarge and 1, 2, 8 or 32 for trn1.32xlarge.</p> </div> </div> </div> <div class="section" id="release-1-11-0-1-1-1"> <h2><a class="toc-backref" href="#id103">Release [1.11.0.1.1.1]</a><a class="headerlink" href="#release-1-11-0-1-1-1" title="Permalink to this headline">#</a></h2> <p>Date: 10/10/2022</p> <div class="section" id="id82"> <h3>Summary<a class="headerlink" href="#id82" title="Permalink to this headline">#</a></h3> <p>This is the initial release of PyTorch Neuron that supports Trainium for users to train their models on the new EC2 Trn1 instances.</p> </div> <div class="section" id="id83"> <h3>What’s new in this release<a class="headerlink" href="#id83" title="Permalink to this headline">#</a></h3> <p>Announcing the first PyTorch Neuron release for training.</p> <ul class="simple"> <li><p>XLA device support for Trainium</p></li> <li><p>PyTorch 1.11 with XLA backend support in torch.distributed</p></li> <li><p>torch-xla distributed support</p></li> <li><p>Single-instance and multi-instance distributed training using torchrun</p></li> <li><p>Support for ParallelCluster and SLURM with node-level scheduling granularity</p></li> <li><p>Persistent cache for compiled graph</p></li> <li><p><a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">neuron_parallel_compile</span></a> utility to help speed up compilation</p></li> <li><p>Optimizer support: SGD, AdamW</p></li> <li><p>Loss functions supported: NLLLoss</p></li> <li><p>Python versions supported: 3.7, 3.8</p></li> <li><p>Multi-instance training support with EFA</p></li> <li><p>Support PyTorch’s BF16 automatic mixed precision</p></li> </ul> </div> <div class="section" id="id84"> <h3>Known Issues and Limitations<a class="headerlink" href="#id84" title="Permalink to this headline">#</a></h3> <div class="section" id="id85"> <h4>Convolution is not supported<a class="headerlink" href="#id85" title="Permalink to this headline">#</a></h4> <p>In this release, convolution is not supported.</p> </div> <div class="section" id="id86"> <h4>Number of data parallel training workers on one Trn1 instance<a class="headerlink" href="#id86" title="Permalink to this headline">#</a></h4> <p>The number of workers used in single-instance data parallel training can be one of the following values: 1 or 2 for trn1.2xlarge and 1, 2, 8 or 32 for trn1.32xlarge.</p> </div> <div class="section" id="id87"> <h4>Drop-out rate ignored in dropout operation<a class="headerlink" href="#id87" title="Permalink to this headline">#</a></h4> <p>A known issue in the compiler’s implementation of dropout caused drop-rate to be ignored. Will be fixed in a follow-on release.</p> </div> <div class="section" id="id88"> <h4>Runtime error “invalid offset in Coalesced_memloc_…” followed by “Failed to process dma block: 1703”<a class="headerlink" href="#id88" title="Permalink to this headline">#</a></h4> <p>Currently, when running MRPC fine-tuning tutorial with <code class="docutils literal notranslate"><span class="pre">bert-base-*</span></code> model, you will encounter runtime error “invalid offset in Coalesced_memloc_…” followed by “Failed to process dma block: 1703”. This issue will be fixed in an upcoming release.</p> </div> <div class="section" id="id89"> <h4>Compilation error: “TongaSBTensor[0x7fb2a46e0830]:TongaSB partitions[0] uint8 %138392[128, 512]”<a class="headerlink" href="#id89" title="Permalink to this headline">#</a></h4> <p>When compiling MRPC fine-tuning tutorial with <code class="docutils literal notranslate"><span class="pre">bert-large-*</span></code> and FP32 (no XLA_USE_BF16=1) for two workers or more, you will encounter compiler error that looks like <code class="docutils literal notranslate"><span class="pre">Error</span> <span class="pre">message:</span>&nbsp; <span class="pre">TongaSBTensor[0x7fb2a46e0830]:TongaSB</span> <span class="pre">partitions[0]</span> <span class="pre">uint8</span> <span class="pre">%138392[128,</span> <span class="pre">512]</span></code> followed by <code class="docutils literal notranslate"><span class="pre">Error</span> <span class="pre">class:</span>&nbsp;&nbsp;&nbsp; <span class="pre">KeyError</span></code>. Single worker fine-tuning is not affected. This issue will be fixed in an upcoming release.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Misc (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../frameworks/torch/inference-torch-neuron.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Inference with <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> (Inf1)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:54.555Z
Inference with torch-neuron (Inf1) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/inference-torch-neuron.html
# Inference with torch-neuron (Inf1) — AWS Neuron Documentation Computer Vision Tutorials - ResNet-50 tutorial [\[html\]](../../src/examples/pytorch/resnet50.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/resnet50.ipynb) - PyTorch YOLOv4 tutorial [\[html\]](../../src/examples/pytorch/yolo_v4.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/yolo_v4.ipynb) Natural Language Processing (NLP) Tutorials - HuggingFace pretrained BERT tutorial [\[html\]](../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.ipynb) - Bring your own HuggingFace pretrained BERT container to Sagemaker Tutorial [\[html\]](../../src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.ipynb) - LibTorch C++ tutorial [\[html\]](torch-neuron/tutorials/tutorial-libtorch.html#pytorch-tutorials-libtorch) - TorchServe tutorial [\[html\]](torch-neuron/tutorials/tutorial-torchserve.html#pytorch-tutorials-torchserve) - HuggingFace MarianMT tutorial [\[html\]](../../src/examples/pytorch/transformers-marianmt.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/transformers-marianmt.ipynb) Utilizing Neuron Capabilities Tutorials - BERT TorchServe tutorial [\[html\]](torch-neuron/tutorials/tutorial-torchserve.html#pytorch-tutorials-torchserve) - NeuronCore Pipeline tutorial [\[html\]](../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.ipynb)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Inference with torch-neuron (Inf1) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Tutorials for Inference with torch-neuron (Inf1)" href="torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> <link rel="prev" title="PyTorch Neuron (torch-neuronx) release notes" href="../../release-notes/torch/torch-neuronx/index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/inference-torch-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="current reference internal" href="#"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"><!-- Inserted RTD Footer --> <div class="injected"> <div class="rst-versions rst-badge" data-toggle="rst-versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book">&nbsp;</span> v: v2.14.1 <span class="fa fa-caret-down"></span> </span> <div class="rst-other-versions"> <dl> <dt>Versions</dt> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/torch/inference-torch-neuron.html">latest</a> </dd> <dd class="rtd-current-item"> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/inference-torch-neuron.html">v2.14.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.0/frameworks/torch/inference-torch-neuron.html">v2.14.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.13.2/frameworks/torch/inference-torch-neuron.html">v2.13.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.13.1/frameworks/torch/inference-torch-neuron.html">v2.13.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.13.0/frameworks/torch/inference-torch-neuron.html">v2.13.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.12.2/frameworks/torch/inference-torch-neuron.html">v2.12.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.12.1/frameworks/torch/inference-torch-neuron.html">v2.12.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.12.0/frameworks/torch/inference-torch-neuron.html">v2.12.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.11.0/frameworks/torch/inference-torch-neuron.html">v2.11.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.10.0/frameworks/torch/inference-torch-neuron.html">v2.10.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.9.1/frameworks/torch/inference-torch-neuron.html">v2.9.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.9.0/frameworks/torch/inference-torch-neuron.html">v2.9.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.8.0/frameworks/torch/inference-torch-neuron.html">v2.8.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.7.0/frameworks/torch/inference-torch-neuron.html">v2.7.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.6.0/frameworks/torch/inference-torch-neuron.html">v2.6.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.5.0/frameworks/torch/inference-torch-neuron.html">v2.5.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.4.0/frameworks/torch/inference-torch-neuron.html">v2.4.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.3.0/frameworks/torch/inference-torch-neuron.html">v2.3.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.19.2/frameworks/torch/inference-torch-neuron.html">v1.19.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.19.1/frameworks/torch/inference-torch-neuron.html">v1.19.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.19.0/frameworks/torch/inference-torch-neuron.html">v1.19.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.18.0/frameworks/torch/inference-torch-neuron.html">v1.18.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.17.2/frameworks/torch/inference-torch-neuron.html">v1.17.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.17.1/frameworks/torch/inference-torch-neuron.html">v1.17.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.17.0/frameworks/torch/inference-torch-neuron.html">v1.17.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.3/frameworks/torch/inference-torch-neuron.html">v1.16.3</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.2/frameworks/torch/inference-torch-neuron.html">v1.16.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.1/frameworks/torch/inference-torch-neuron.html">v1.16.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.0/frameworks/torch/inference-torch-neuron.html">v1.16.0</a> </dd> </dl> <dl> <dt>Downloads</dt> <dd><a href="//awsdocs-neuron.readthedocs-hosted.com/_/downloads/en/v2.14.1/pdf/">PDF</a></dd> </dl> <dl> <dt>On GitHub</dt> <dd> <a href="https://github.com/aws/aws-neuron-sdk/blob/v2.14.1//frameworks/torch/inference-torch-neuron.rst">View</a> </dd> </dl> <hr> <div> <div> Documentation hosted by <a href="https://readthedocs.com">Read the Docs</a> </div> </div> </div> </div> </div> </div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/inference-torch-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/inference-torch-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/torch/inference-torch-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Inference with torch-neuron (Inf1)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="inference-with-torch-neuron-inf1"> <span id="inference-torch-neuron"></span><h1>Inference with <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> (Inf1)<a class="headerlink" href="#inference-with-torch-neuron-inf1" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Setup (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</div> </div> <a class="sd-stretched-link reference internal" href="../../general/setup/torch-neuron.html#setup-torch-neuron"><span class="std std-ref"></span></a></div> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" id="torch-neuronx-training-tutorials"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Tutorials (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body docutils"> <div class="sd-tab-set docutils"> <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-0" id="id1"> Computer Vision Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p class="sd-card-text">ResNet-50 tutorial <a class="reference internal" href="../../src/examples/pytorch/resnet50.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/resnet50.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text">PyTorch YOLOv4 tutorial <a class="reference internal" href="../../src/examples/pytorch/yolo_v4.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/yolo_v4.ipynb">[notebook]</a></p></li> </ul> </div> <input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-1" id="id2"> Natural Language Processing (NLP) Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p class="sd-card-text">HuggingFace pretrained BERT tutorial <a class="reference internal" href="../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text">Bring your own HuggingFace pretrained BERT container to Sagemaker Tutorial <a class="reference internal" href="../../src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text">LibTorch C++ tutorial <a class="reference internal" href="torch-neuron/tutorials/tutorial-libtorch.html#pytorch-tutorials-libtorch"><span class="std std-ref">[html]</span></a></p></li> <li><p class="sd-card-text">TorchServe tutorial <a class="reference internal" href="torch-neuron/tutorials/tutorial-torchserve.html#pytorch-tutorials-torchserve"><span class="std std-ref">[html]</span></a></p></li> <li><p class="sd-card-text">HuggingFace MarianMT tutorial <a class="reference internal" href="../../src/examples/pytorch/transformers-marianmt.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/transformers-marianmt.ipynb">[notebook]</a></p></li> </ul> </div> <input id="sd-tab-item-2" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-2" id="id3"> Utilizing Neuron Capabilities Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p class="sd-card-text">BERT TorchServe tutorial <a class="reference internal" href="torch-neuron/tutorials/tutorial-torchserve.html#pytorch-tutorials-torchserve"><span class="std std-ref">[html]</span></a></p></li> <li><p class="sd-card-text">NeuronCore Pipeline tutorial <a class="reference internal" href="../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.ipynb">[notebook]</a></p></li> </ul> </div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p class="sd-card-text">To use Jupyter Notebook see:</p> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference">AWS Neuron Samples GitHub Repository</a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> API Reference Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuron/api-compilation-python-api.html#torch-neuron-trace-api"><span class="std std-ref">PyTorch Neuron trace Python API</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuron/api-torch-neuron-dataparallel-api.html#api-torch-neuron-dataparallel-api"><span class="std std-ref">torch.neuron.DataParallel API</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuron/api-core-placement.html#torch-core-placement-api"><span class="std std-ref">PyTorch Neuron (torch-neuron) Core Placement API [Experimental]</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html#bucketing-app-note"><span class="std std-ref">Running Inference on Variable Input Shapes with Bucketing</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html#torch-neuron-dataparallel-app-note"><span class="std std-ref">Data Parallel Inference on PyTorch Neuron</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuron/guides/torch-lstm-support.html#torch-neuron-lstm-support"><span class="std std-ref">Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuron/guides/core-placement/torch-core-placement.html#torch-neuron-core-placement-guide"><span class="std std-ref">PyTorch Neuron (torch-neuron) Core Placement</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Misc (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuron/troubleshooting-guide.html#pytorch-neuron-inference-troubleshooting"><span class="std std-ref">Troubleshooting Guide for PyTorch Neuron (torch-neuron)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html#pytorch-neuron-rn"><span class="std std-ref">PyTorch Neuron (torch-neuron) release notes</span></a></p></li> </ul> </div> </details><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../release-notes/torch/torch-neuronx/index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) release notes</p> </div> </a> <a class="right-next" id="next-link" href="torch-neuron/tutorials/tutorials-inference-torch-neuron.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Tutorials for Inference with <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> (Inf1)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:54.951Z
Tutorials for Inference with torch-neuron (Inf1) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html
# Tutorials for Inference with torch-neuron (Inf1) — AWS Neuron Documentation Computer Vision Tutorials - ResNet-50 tutorial [\[html\]](../../../../src/examples/pytorch/resnet50.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/resnet50.ipynb) - PyTorch YOLOv4 tutorial [\[html\]](../../../../src/examples/pytorch/yolo_v4.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/yolo_v4.ipynb) Natural Language Processing (NLP) Tutorials - HuggingFace pretrained BERT tutorial [\[html\]](../../../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.ipynb) - Bring your own HuggingFace pretrained BERT container to Sagemaker Tutorial [\[html\]](../../../../src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.ipynb) - LibTorch C++ tutorial [\[html\]](tutorial-libtorch.html#pytorch-tutorials-libtorch) - TorchServe tutorial [\[html\]](tutorial-torchserve.html#pytorch-tutorials-torchserve) - HuggingFace MarianMT tutorial [\[html\]](../../../../src/examples/pytorch/transformers-marianmt.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/transformers-marianmt.ipynb) Utilizing Neuron Capabilities Tutorials - BERT TorchServe tutorial [\[html\]](tutorial-torchserve.html#pytorch-tutorials-torchserve) - NeuronCore Pipeline tutorial [\[html\]](../../../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.ipynb)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Tutorials for Inference with torch-neuron (Inf1) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Computer Vision Tutorials (torch-neuron)" href="tutorials-torch-neuron-computervision.html"> <link rel="prev" title="Inference with torch-neuron (Inf1)" href="../../inference-torch-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Tutorials for Inference with torch-neuron (Inf1)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tutorials-for-inference-with-torch-neuron-inf1"> <h1>Tutorials for Inference with <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> (Inf1)<a class="headerlink" href="#tutorials-for-inference-with-torch-neuron-inf1" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <div class="sd-tab-set docutils"> <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-0" id="id1"> Computer Vision Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p>ResNet-50 tutorial <a class="reference internal" href="../../../../src/examples/pytorch/resnet50.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/resnet50.ipynb">[notebook]</a></p></li> <li><p>PyTorch YOLOv4 tutorial <a class="reference internal" href="../../../../src/examples/pytorch/yolo_v4.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/yolo_v4.ipynb">[notebook]</a></p></li> </ul> </div> <input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-1" id="id2"> Natural Language Processing (NLP) Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p>HuggingFace pretrained BERT tutorial <a class="reference internal" href="../../../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.ipynb">[notebook]</a></p></li> <li><p>Bring your own HuggingFace pretrained BERT container to Sagemaker Tutorial <a class="reference internal" href="../../../../src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.ipynb">[notebook]</a></p></li> <li><p>LibTorch C++ tutorial <a class="reference internal" href="tutorial-libtorch.html#pytorch-tutorials-libtorch"><span class="std std-ref">[html]</span></a></p></li> <li><p>TorchServe tutorial <a class="reference internal" href="tutorial-torchserve.html#pytorch-tutorials-torchserve"><span class="std std-ref">[html]</span></a></p></li> <li><p>HuggingFace MarianMT tutorial <a class="reference internal" href="../../../../src/examples/pytorch/transformers-marianmt.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/transformers-marianmt.ipynb">[notebook]</a></p></li> </ul> </div> <input id="sd-tab-item-2" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-2" id="id3"> Utilizing Neuron Capabilities Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p>BERT TorchServe tutorial <a class="reference internal" href="tutorial-torchserve.html#pytorch-tutorials-torchserve"><span class="std std-ref">[html]</span></a></p></li> <li><p>NeuronCore Pipeline tutorial <a class="reference internal" href="../../../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.ipynb">[notebook]</a></p></li> </ul> </div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>To use Jupyter Notebook see:</p> <ul class="simple"> <li><p><a class="reference internal" href="../../../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p><a class="reference internal" href="../../../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../inference-torch-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Inference with <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> (Inf1)</p> </div> </a> <a class="right-next" id="next-link" href="tutorials-torch-neuron-computervision.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Computer Vision Tutorials (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:55.431Z
Natural Language Processing (NLP) Tutorials (torch-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html
# Natural Language Processing (NLP) Tutorials (torch-neuron) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.rst) - [.rst](../../../../_sources/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.rst.txt) ## Natural Language Processing (NLP) Tutorials (torch-neuron) _This document is relevant for_: `Inf1` ## Natural Language Processing (NLP) Tutorials (`torch-neuron`)[#](#natural-language-processing-nlp-tutorials-torch-neuron "Permalink to this headline") - HuggingFace pretrained BERT tutorial [\[html\]](../../../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.ipynb) - Bring your own HuggingFace pretrained BERT container to Sagemaker Tutorial [\[html\]](../../../../src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.ipynb) - LibTorch C++ tutorial [\[html\]](tutorial-libtorch.html#pytorch-tutorials-libtorch) - TorchServe tutorial [\[html\]](tutorial-torchserve.html#pytorch-tutorials-torchserve) - HuggingFace MarianMT tutorial [\[html\]](../../../../src/examples/pytorch/transformers-marianmt.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/transformers-marianmt.ipynb) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Natural Language Processing (NLP) Tutorials (torch-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Compiling and Deploying HuggingFace Pretrained BERT" href="../../../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html"> <link rel="prev" title="Computer Vision Tutorials (torch-neuron)" href="tutorials-torch-neuron-computervision.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-inference-torch-neuron.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Natural Language Processing (NLP) Tutorials (torch-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="natural-language-processing-nlp-tutorials-torch-neuron"> <h1>Natural Language Processing (NLP) Tutorials (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<a class="headerlink" href="#natural-language-processing-nlp-tutorials-torch-neuron" title="Permalink to this headline">#</a></h1> <ul class="simple"> <li><p>HuggingFace pretrained BERT tutorial <a class="reference internal" href="../../../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.ipynb">[notebook]</a></p></li> <li><p>Bring your own HuggingFace pretrained BERT container to Sagemaker Tutorial <a class="reference internal" href="../../../../src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/byoc_sm_bert_tutorial/sagemaker_container_neuron.ipynb">[notebook]</a></p></li> <li><p>LibTorch C++ tutorial <a class="reference internal" href="tutorial-libtorch.html#pytorch-tutorials-libtorch"><span class="std std-ref">[html]</span></a></p></li> <li><p>TorchServe tutorial <a class="reference internal" href="tutorial-torchserve.html#pytorch-tutorials-torchserve"><span class="std std-ref">[html]</span></a></p></li> <li><p>HuggingFace MarianMT tutorial <a class="reference internal" href="../../../../src/examples/pytorch/transformers-marianmt.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/transformers-marianmt.ipynb">[notebook]</a></p></li> </ul> <div class="toctree-wrapper compound"> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tutorials-torch-neuron-computervision.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Computer Vision Tutorials (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../../src/examples/pytorch/bert_tutorial/tutorial_pretrained_bert.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Compiling and Deploying HuggingFace Pretrained BERT</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:55.871Z
Computer Vision Tutorials (torch-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html
# Computer Vision Tutorials (torch-neuron) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.rst) - [.rst](../../../../_sources/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.rst.txt) ## Computer Vision Tutorials (torch-neuron) _This document is relevant for_: `Inf1` ## Computer Vision Tutorials (`torch-neuron`)[#](#computer-vision-tutorials-torch-neuron "Permalink to this headline") - ResNet-50 tutorial [\[html\]](../../../../src/examples/pytorch/resnet50.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/resnet50.ipynb) - PyTorch YOLOv4 tutorial [\[html\]](../../../../src/examples/pytorch/yolo_v4.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/yolo_v4.ipynb) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Computer Vision Tutorials (torch-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Natural Language Processing (NLP) Tutorials (torch-neuron)" href="tutorials-torch-neuron-nlp.html"> <link rel="prev" title="Tutorials for Inference with torch-neuron (Inf1)" href="tutorials-inference-torch-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-inference-torch-neuron.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Computer Vision Tutorials (torch-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="computer-vision-tutorials-torch-neuron"> <h1>Computer Vision Tutorials (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<a class="headerlink" href="#computer-vision-tutorials-torch-neuron" title="Permalink to this headline">#</a></h1> <ul class="simple"> <li><p>ResNet-50 tutorial <a class="reference internal" href="../../../../src/examples/pytorch/resnet50.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/resnet50.ipynb">[notebook]</a></p></li> <li><p>PyTorch YOLOv4 tutorial <a class="reference internal" href="../../../../src/examples/pytorch/yolo_v4.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/yolo_v4.ipynb">[notebook]</a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tutorials-inference-torch-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Tutorials for Inference with <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> (Inf1)</p> </div> </a> <a class="right-next" id="next-link" href="tutorials-torch-neuron-nlp.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Natural Language Processing (NLP) Tutorials (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:56.147Z
Utilizing Neuron Capabilities Tutorials — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html
# Utilizing Neuron Capabilities Tutorials — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.rst) - [.rst](../../../../_sources/frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.rst.txt) ## Utilizing Neuron Capabilities Tutorials _This document is relevant for_: `Inf1` ## Utilizing Neuron Capabilities Tutorials[#](#utilizing-neuron-capabilities-tutorials "Permalink to this headline") - BERT TorchServe tutorial [\[html\]](tutorial-torchserve.html#pytorch-tutorials-torchserve) - NeuronCore Pipeline tutorial [\[html\]](../../../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.ipynb) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Utilizing Neuron Capabilities Tutorials — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Using NeuronCore Pipeline with PyTorch" href="../../../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html"> <link rel="prev" title="Transformers MarianMT Tutorial" href="../../../../src/examples/pytorch/transformers-marianmt.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-inference-torch-neuron.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Utilizing Neuron Capabilities Tutorials</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="utilizing-neuron-capabilities-tutorials"> <h1>Utilizing Neuron Capabilities Tutorials<a class="headerlink" href="#utilizing-neuron-capabilities-tutorials" title="Permalink to this headline">#</a></h1> <ul class="simple"> <li><p>BERT TorchServe tutorial <a class="reference internal" href="tutorial-torchserve.html#pytorch-tutorials-torchserve"><span class="std std-ref">[html]</span></a></p></li> <li><p>NeuronCore Pipeline tutorial <a class="reference internal" href="../../../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.ipynb">[notebook]</a></p></li> </ul> <div class="toctree-wrapper compound"> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../src/examples/pytorch/transformers-marianmt.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Transformers MarianMT Tutorial</p> </div> </a> <a class="right-next" id="next-link" href="../../../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Using NeuronCore Pipeline with PyTorch</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:56.617Z
Additional Examples (torch-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html
# Additional Examples (torch-neuron) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.rst) - [.rst](../../../_sources/frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.rst.txt) ## Additional Examples (torch-neuron) _This document is relevant for_: `Inf1` ## Additional Examples (`torch-neuron`)[#](#additional-examples-torch-neuron "Permalink to this headline") - [AWS Neuron Samples GitHub Repository](https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Additional Examples (torch-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="API Reference Guide (torch-neuron)" href="api-reference-guide-torch-neuron.html"> <link rel="prev" title="Using NeuronCore Pipeline with PyTorch" href="../../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Additional Examples </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Additional Examples (torch-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="additional-examples-torch-neuron"> <h1>Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<a class="headerlink" href="#additional-examples-torch-neuron" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference">AWS Neuron Samples GitHub Repository</a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../src/examples/pytorch/pipeline_tutorial/neuroncore_pipeline_pytorch.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Using NeuronCore Pipeline with PyTorch</p> </div> </a> <a class="right-next" id="next-link" href="api-reference-guide-torch-neuron.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">API Reference Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:57.071Z
PyTorch-Neuron trace python API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/api-compilation-python-api.html
# PyTorch-Neuron trace python API — AWS Neuron Documentation Toggle in-page Table of Contents Contents - [Example Usage](#example-usage) - [Function Compilation](#function-compilation) - [Module Compilation](#module-compilation) - [Pre-Trained Model Compilation](#pre-trained-model-compilation) - [Compiling models with torch.jit.trace kwargs](#compiling-models-with-torch-jit-trace-kwargs) - [Dynamic Batching](#dynamic-batching) - [Manual Partitioning](#manual-partitioning) - [Separate Weights](#separate-weights) ## Contents - [Example Usage](#example-usage) - [Function Compilation](#function-compilation) - [Module Compilation](#module-compilation) - [Pre-Trained Model Compilation](#pre-trained-model-compilation) - [Compiling models with torch.jit.trace kwargs](#compiling-models-with-torch-jit-trace-kwargs) - [Dynamic Batching](#dynamic-batching) - [Manual Partitioning](#manual-partitioning) - [Separate Weights](#separate-weights) _This document is relevant for_: `Inf1` ## PyTorch-Neuron trace python API[#](#pytorch-neuron-trace-python-api "Permalink to this headline") The PyTorch-Neuron trace Python API provides a method to generate PyTorch models for execution on Inferentia, which can be serialized as TorchScript. It is analogous to [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function in PyTorch. torch\_neuron.trace(_model_, _example\_inputs_, _\*\*kwargs_)[#](#torch_neuron.trace "Permalink to this definition") The [`torch_neuron.trace()`](#torch_neuron.trace "torch_neuron.trace") method sends operations to the Neuron-Compiler (`neuron-cc`) for compilation and embeds compiled artifacts in a TorchScript graph. Compilation can be done on any EC2 machine with sufficient memory and compute resources. c5.4xlarge or larger is recommended. Options can be passed to Neuron compiler via the compile function. See [Neuron compiler CLI Reference Guide (neuron-cc)](../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference) for more information about compiler options. This function partitions nodes into operations that are supported by Neuron and operations which are not. Operations which are not supported by Neuron are run on CPU. Graph partitioning can be controlled by the `subgraph_builder_function`, `minimum_segment_size`, and `fallback` parameters (See below). By default all supported operations are compiled and run on Neuron. The compiled graph can be saved using the [`torch.jit.save()`](https://pytorch.org/docs/master/generated/torch.jit.save.html#torch.jit.save "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function and restored using [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function for inference on Inf1 instances. During inference, the previously compiled artifacts will be loaded into the Neuron Runtime for inference execution. _Required Arguments_ Parameters - **model** ([_Module_](https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_,__callable_) – The functions that that will be run with `example_inputs` arguments. The arguments and return types must compatible with [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). When a [`Module`](https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") is passed to [`torch_neuron.trace()`](#torch_neuron.trace "torch_neuron.trace"), only the `forward()` method is run and traced. - **example\_inputs** ([_tuple_](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.11)")) – A tuple of example inputs that will be passed to the `model` while tracing. The resulting trace can be run with inputs of different types and shapes assuming the traced operations support those types and shapes. This parameter may also be a single [`torch.Tensor`](https://pytorch.org/docs/master/tensors.html#torch.Tensor "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") in which case it is automatically wrapped in a `tuple`. _Optional Keyword Arguments_ Keyword Arguments - **compiler\_args** ([_list_](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.11)")_\[_[_str_](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.11)")_\]_) – List of strings representing `neuron-cc` compiler arguments. Note that these arguments apply to all subgraphs generated by allowlist partitioning. For example, use `compiler_args=['--neuroncore-pipeline-cores', '4']` to set number of NeuronCores per subgraph to 4. See [Neuron compiler CLI Reference Guide (neuron-cc)](../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference) for more information about compiler options. - **compiler\_timeout** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – Timeout in seconds for waiting `neuron-cc` to complete. Exceeding this timeout will cause a `subprocess.TimeoutExpired` exception. - **compiler\_workdir** ([_str_](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.11)")) – Work directory used by `neuron-cc`. Useful for debugging and/or inspecting `neuron-cc` logs/IRs. - **subgraph\_builder\_function** ([_callable_](https://docs.python.org/3/library/functions.html#callable "(in Python v3.11)")) – A function which is evaluated on each node during graph partitioning. This takes in a torch graph operator node and returns a [`bool`](https://docs.python.org/3/library/functions.html#bool "(in Python v3.11)") value of whether it should be included in the fused Neuron graph or not. By default the partitioner selects all operators which are supported by Neuron. - **minimum\_segment\_size** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – A parameter used during partitioning. This specifies the minimum number of graph nodes which should be compiled into a Neuron graph (default= `2`). If the number of nodes is smaller than this size, the operations will run on CPU. - **single\_fusion\_ratio\_threshold** ([_float_](https://docs.python.org/3/library/functions.html#float "(in Python v3.11)")) – A parameter used during partitioning. During partitioning, if a single partition contains a fraction of operations greater than this threshold, only one graph partition will be compiled (default= `0.6`). This is used to avoid compiling many small Neuron graphs. To force compilation of all graphs to Neuron (even when they are very small), a value of `1.0` can be used. - **fallback** ([_bool_](https://docs.python.org/3/library/functions.html#bool "(in Python v3.11)")) – A function parameter to turn off graph partitioning. Indicates whether to attempt to fall back to CPU operations if an operation is not supported by Neuron. By default this is `True`. If this is set to `False` and an operation is not supported by Neuron, this will fail compilation and raise an `AttributeError`. - **dynamic\_batch\_size** ([_bool_](https://docs.python.org/3/library/functions.html#bool "(in Python v3.11)")) – A flag to allow Neuron graphs to consume variable sized batches of data. Dynamic sizing is restricted to the 0th dimension of a tensor. - **optimizations** ([_list_](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.11)")) – A list of [`Optimization`](#torch_neuron.Optimization "torch_neuron.Optimization") passes to apply to the model. - **separate\_weights** ([_bool_](https://docs.python.org/3/library/functions.html#bool "(in Python v3.11)")) – A flag to enable compilation of models with over 1.9GB of constant parameters. By default this flag is `False`. If this is set to `True` and the compiler version is not new enough to support the flag, this will raise an `NotImplementedError`. - **\*\*kwargs** – All other keyword arguments will be forwarded directly to [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). This supports flags like `strict=False` in order to allow dictionary outputs. Returns The traced [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") with embedded compiled neuron sub-graphs. Operations in this module will run on Neuron unless they are not supported by Neuron or manually partitioned to run on CPU. Note that in `torch<1.8` This would return a [`ScriptFunction`](https://pytorch.org/docs/master/generated/torch.jit.ScriptFunction.html#torch.jit.ScriptFunction "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") if the input was function type. Return type [_ScriptModule_](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"), [_ScriptFunction_](https://pytorch.org/docs/master/generated/torch.jit.ScriptFunction.html#torch.jit.ScriptFunction "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") _class_ torch\_neuron.Optimization[#](#torch_neuron.Optimization "Permalink to this definition") A set of optimization passes that can be applied to the model. FLOAT32\_TO\_FLOAT16[#](#torch_neuron.Optimization.FLOAT32_TO_FLOAT16 "Permalink to this definition") A post-processing pass that converts all `torch.float32` tensors to `torch.float16` tensors. The advantage to this optimization pass is that input/output tensors will be type cast. This reduces the amount of data that will be copied to and from Inferentia hardware. The resulting traced model will accept both `torch.float32` and `torch.float16` inputs where the model used `torch.float32` inputs during tracing. It is only beneficial to enable this optimization if the throughput of a model is highly dependent upon data transfer speed. This optimization is not recommended if the final application will use `torch.float32` inputs since the `torch.float16` type cast will occur on CPU during inference. ## Example Usage[#](#example-usage "Permalink to this headline") ### Function Compilation[#](#function-compilation "Permalink to this headline") ``` import torch import torch_neuron def foo(x, y): return 2 * x + y # Run `foo` with the provided inputs and record the tensor operations traced_foo = torch.neuron.trace(foo, (torch.rand(3), torch.rand(3))) # `traced_foo` can now be run with the TorchScript interpreter or saved # and loaded in a Python-free environment torch.jit.save(traced_foo, 'foo.pt') traced_foo = torch.jit.load('foo.pt') ``` ### Module Compilation[#](#module-compilation "Permalink to this headline") ``` import torch import torch_neuron import torch.nn as nn class Net(nn.Module): def __init__(self): super(Net, self).__init__() self.conv = nn.Conv2d(1, 1, 3) def forward(self, x): return self.conv(x) + 1 n = Net() n.eval() inputs = torch.rand(1, 1, 3, 3) # Trace a specific method and construct `ScriptModule` with # a single `forward` method neuron_forward = torch.neuron.trace(n.forward, inputs) # Trace a module (implicitly traces `forward`) and constructs a # `ScriptModule` with a single `forward` method neuron_net = torch.neuron.trace(n, inputs) ``` ### Pre-Trained Model Compilation[#](#pre-trained-model-compilation "Permalink to this headline") The following is an example usage of the compilation Python API, with default compilation arguments, using a pretrained [`torch.nn.Module`](https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"): ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image) ``` ### Compiling models with torch.jit.trace kwargs[#](#compiling-models-with-torch-jit-trace-kwargs "Permalink to this headline") This example uses the `strict=False` flag to compile a model with dictionary outputs. Similarly, any other keyword argument of [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") can be passed directly to [`torch_neuron.trace()`](#torch_neuron.trace "torch_neuron.trace") so that it is passed to the underlying trace call. ``` import torch import torch_neuron import torch.nn as nn class Model(nn.Module): def __init__(self): super(Model, self).__init__() self.conv = nn.Conv2d(1, 1, 3) def forward(self, x): return {'conv': self.conv(x) + 1} model = Model() model.eval() inputs = torch.rand(1, 1, 3, 3) # use the strict=False kwarg to compile a model with dictionary outputs # the model output format does not change model_neuron = torch.neuron.trace(model, inputs, strict=False) ``` ### Dynamic Batching[#](#dynamic-batching "Permalink to this headline") This example uses the optional `dynamic_batch_size` option in order to support variable sized batches at inference time. ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input of batch size 1 image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image, dynamic_batch_size=True) # Execute with a batch of 7 images batch = torch.rand([7, 3, 224, 224]) results = model_neuron(batch) ``` ### Manual Partitioning[#](#manual-partitioning "Permalink to this headline") The following example uses the optional `subgraph_builder_function` parameter to ensure that only a specific convolution layer is compiled to Neuron. The remaining operations are executed on CPU. ``` import torch import torch_neuron import torch.nn as nn class ExampleConvolutionLayer(nn.Module): def __init__(self): super().__init__() self.conv = nn.Conv2d(1, 1, 3) def forward(self, x): return self.conv(x) + 1 class Model(nn.Module): def __init__(self): super().__init__() self.layer = ExampleConvolutionLayer() def forward(self, x): return self.layer(x) * 100 def subgraph_builder_function(node) -> bool: """Select if the node will be included in the Neuron graph""" # Node names are tuples of Module names. if 'ExampleConvolutionLayer' in node.name: return True # Ignore all operations not in the example convolution layer return False model = Model() model.eval() inputs = torch.rand(1, 1, 3, 3) # Log output shows that `aten::_convolution` and `aten::add` are compiled # but `aten::mul` is not. This will seamlessly switch between Neuron/CPU # execution in a single graph. neuron_model = torch_neuron.trace( model, inputs, subgraph_builder_function=subgraph_builder_function ) ``` ### Separate Weights[#](#separate-weights "Permalink to this headline") This example uses the optional `separate_weights` option in order to support compilation of models greater than 1.9GB. ``` import torch import torch_neuron from torchvision import models # Load the model model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) #the models' output format does not change model_neuron = torch.neuron.trace(model, image, separate_weights=True) ``` _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch-Neuron trace python API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="torch.neuron.DataParallel API" href="api-torch-neuron-dataparallel-api.html"> <link rel="prev" title="API Reference Guide (torch-neuron)" href="api-reference-guide-torch-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/api-compilation-python-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/api-compilation-python-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/api-compilation-python-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuron/api-compilation-python-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#function-compilation"> Function Compilation </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#module-compilation"> Module Compilation </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pre-trained-model-compilation"> Pre-Trained Model Compilation </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compiling-models-with-torch-jit-trace-kwargs"> Compiling models with torch.jit.trace kwargs </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic Batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#manual-partitioning"> Manual Partitioning </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#separate-weights"> Separate Weights </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch-Neuron trace python API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#function-compilation"> Function Compilation </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#module-compilation"> Module Compilation </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pre-trained-model-compilation"> Pre-Trained Model Compilation </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compiling-models-with-torch-jit-trace-kwargs"> Compiling models with torch.jit.trace kwargs </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic Batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#manual-partitioning"> Manual Partitioning </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#separate-weights"> Separate Weights </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="pytorch-neuron-trace-python-api"> <span id="torch-neuron-trace-api"></span><h1>PyTorch-Neuron trace python API<a class="headerlink" href="#pytorch-neuron-trace-python-api" title="Permalink to this headline">#</a></h1> <p>The PyTorch-Neuron trace Python API provides a method to generate PyTorch models for execution on Inferentia, which can be serialized as TorchScript. It is analogous to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a> function in PyTorch.</p> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuron.trace"> <span class="sig-prename descclassname"><span class="pre">torch_neuron.</span></span><span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">example_inputs</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuron.trace" title="Permalink to this definition">#</a></dt> <dd><p>The <a class="reference internal" href="#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> method sends operations to the Neuron-Compiler (<code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code>) for compilation and embeds compiled artifacts in a TorchScript graph.</p> <p>Compilation can be done on any EC2 machine with sufficient memory and compute resources. c5.4xlarge or larger is recommended.</p> <p>Options can be passed to Neuron compiler via the compile function. See <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference"><span class="std std-ref">Neuron compiler CLI Reference Guide (neuron-cc)</span></a> for more information about compiler options.</p> <p>This function partitions nodes into operations that are supported by Neuron and operations which are not. Operations which are not supported by Neuron are run on CPU. Graph partitioning can be controlled by the <code class="docutils literal notranslate"><span class="pre">subgraph_builder_function</span></code>, <code class="docutils literal notranslate"><span class="pre">minimum_segment_size</span></code>, and <code class="docutils literal notranslate"><span class="pre">fallback</span></code> parameters (See below). By default all supported operations are compiled and run on Neuron.</p> <p>The compiled graph can be saved using the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.save.html#torch.jit.save" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.save()</span></code></a> function and restored using <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a> function for inference on Inf1 instances. During inference, the previously compiled artifacts will be loaded into the Neuron Runtime for inference execution.</p> <p><em>Required Arguments</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>model</strong> (<a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>Module</em></a><em>,</em><em>callable</em>) – The functions that that will be run with <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> arguments. The arguments and return types must compatible with <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a>. When a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code></a> is passed to <a class="reference internal" href="#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a>, only the <code class="xref py py-func docutils literal notranslate"><span class="pre">forward()</span></code> method is run and traced.</p></li> <li><p><strong>example_inputs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><em>tuple</em></a>) – A tuple of example inputs that will be passed to the <code class="docutils literal notranslate"><span class="pre">model</span></code> while tracing. The resulting trace can be run with inputs of different types and shapes assuming the traced operations support those types and shapes. This parameter may also be a single <a class="reference external" href="https://pytorch.org/docs/master/tensors.html#torch.Tensor" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.Tensor</span></code></a> in which case it is automatically wrapped in a <code class="docutils literal notranslate"><span class="pre">tuple</span></code>.</p></li> </ul> </dd> </dl> <p><em>Optional Keyword Arguments</em></p> <dl class="field-list simple"> <dt class="field-odd">Keyword Arguments</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>compiler_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – List of strings representing <code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code> compiler arguments. Note that these arguments apply to all subgraphs generated by allowlist partitioning. For example, use <code class="code docutils literal notranslate"><span class="pre">compiler_args=['--neuroncore-pipeline-cores',</span> <span class="pre">'4']</span></code> to set number of NeuronCores per subgraph to 4. See <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference"><span class="std std-ref">Neuron compiler CLI Reference Guide (neuron-cc)</span></a> for more information about compiler options.</p></li> <li><p><strong>compiler_timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Timeout in seconds for waiting <code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code> to complete. Exceeding this timeout will cause a <code class="docutils literal notranslate"><span class="pre">subprocess.TimeoutExpired</span></code> exception.</p></li> <li><p><strong>compiler_workdir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – Work directory used by <code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code>. Useful for debugging and/or inspecting <code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code> logs/IRs.</p></li> <li><p><strong>subgraph_builder_function</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#callable" title="(in Python v3.11)"><em>callable</em></a>) – A function which is evaluated on each node during graph partitioning. This takes in a torch graph operator node and returns a <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> value of whether it should be included in the fused Neuron graph or not. By default the partitioner selects all operators which are supported by Neuron.</p></li> <li><p><strong>minimum_segment_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – A parameter used during partitioning. This specifies the minimum number of graph nodes which should be compiled into a Neuron graph (default= <code class="code docutils literal notranslate"><span class="pre">2</span></code>). If the number of nodes is smaller than this size, the operations will run on CPU.</p></li> <li><p><strong>single_fusion_ratio_threshold</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a>) – A parameter used during partitioning. During partitioning, if a single partition contains a fraction of operations greater than this threshold, only one graph partition will be compiled (default= <code class="code docutils literal notranslate"><span class="pre">0.6</span></code>). This is used to avoid compiling many small Neuron graphs. To force compilation of all graphs to Neuron (even when they are very small), a value of <code class="docutils literal notranslate"><span class="pre">1.0</span></code> can be used.</p></li> <li><p><strong>fallback</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – A function parameter to turn off graph partitioning. Indicates whether to attempt to fall back to CPU operations if an operation is not supported by Neuron. By default this is <code class="docutils literal notranslate"><span class="pre">True</span></code>. If this is set to <code class="docutils literal notranslate"><span class="pre">False</span></code> and an operation is not supported by Neuron, this will fail compilation and raise an <code class="docutils literal notranslate"><span class="pre">AttributeError</span></code>.</p></li> <li><p><strong>dynamic_batch_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – A flag to allow Neuron graphs to consume variable sized batches of data. Dynamic sizing is restricted to the 0th dimension of a tensor.</p></li> <li><p><strong>optimizations</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><em>list</em></a>) – A list of <a class="reference internal" href="#torch_neuron.Optimization" title="torch_neuron.Optimization"><code class="xref py py-class docutils literal notranslate"><span class="pre">Optimization</span></code></a> passes to apply to the model.</p></li> <li><p><strong>separate_weights</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – A flag to enable compilation of models with over 1.9GB of constant parameters. By default this flag is <code class="docutils literal notranslate"><span class="pre">False</span></code>. If this is set to <code class="docutils literal notranslate"><span class="pre">True</span></code> and the compiler version is not new enough to support the flag, this will raise an <code class="docutils literal notranslate"><span class="pre">NotImplementedError</span></code>.</p></li> <li><p><strong>**kwargs</strong> – </p><p>All other keyword arguments will be forwarded directly to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a>. This supports flags like <code class="docutils literal notranslate"><span class="pre">strict=False</span></code> in order to allow dictionary outputs.</p> <p></p></li> </ul> </dd> <dt class="field-even">Returns</dt> <dd class="field-even"><p></p><p>The traced <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> with embedded compiled neuron sub-graphs. Operations in this module will run on Neuron unless they are not supported by Neuron or manually partitioned to run on CPU.</p> <p>Note that in <code class="docutils literal notranslate"><span class="pre">torch&lt;1.8</span></code> This would return a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptFunction.html#torch.jit.ScriptFunction" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptFunction</span></code></a> if the input was function type.</p> <p></p> </dd> <dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>ScriptModule</em></a>, <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptFunction.html#torch.jit.ScriptFunction" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>ScriptFunction</em></a></p> </dd> </dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="torch_neuron.Optimization"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">torch_neuron.</span></span><span class="sig-name descname"><span class="pre">Optimization</span></span><a class="headerlink" href="#torch_neuron.Optimization" title="Permalink to this definition">#</a></dt> <dd><p>A set of optimization passes that can be applied to the model.</p> <dl class="py attribute"> <dt class="sig sig-object py" id="torch_neuron.Optimization.FLOAT32_TO_FLOAT16"> <span class="sig-name descname"><span class="pre">FLOAT32_TO_FLOAT16</span></span><a class="headerlink" href="#torch_neuron.Optimization.FLOAT32_TO_FLOAT16" title="Permalink to this definition">#</a></dt> <dd><p>A post-processing pass that converts all <code class="xref py py-attr docutils literal notranslate"><span class="pre">torch.float32</span></code> tensors to <code class="xref py py-attr docutils literal notranslate"><span class="pre">torch.float16</span></code> tensors. The advantage to this optimization pass is that input/output tensors will be type cast. This reduces the amount of data that will be copied to and from Inferentia hardware. The resulting traced model will accept both <code class="xref py py-attr docutils literal notranslate"><span class="pre">torch.float32</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">torch.float16</span></code> inputs where the model used <code class="xref py py-attr docutils literal notranslate"><span class="pre">torch.float32</span></code> inputs during tracing. It is only beneficial to enable this optimization if the throughput of a model is highly dependent upon data transfer speed. This optimization is not recommended if the final application will use <code class="xref py py-attr docutils literal notranslate"><span class="pre">torch.float32</span></code> inputs since the <code class="xref py py-attr docutils literal notranslate"><span class="pre">torch.float16</span></code> type cast will occur on CPU during inference.</p> </dd></dl> </dd></dl> <div class="section" id="example-usage"> <h2>Example Usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">#</a></h2> <div class="section" id="function-compilation"> <h3>Function Compilation<a class="headerlink" href="#function-compilation" title="Permalink to this headline">#</a></h3> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="k">def</span> <span class="nf">foo</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span> <span class="k">return</span> <span class="mi">2</span> <span class="o">*</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span> <span class="c1"># Run `foo` with the provided inputs and record the tensor operations</span> <span class="n">traced_foo</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">foo</span><span class="p">,</span> <span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">3</span><span class="p">),</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">3</span><span class="p">)))</span> <span class="c1"># `traced_foo` can now be run with the TorchScript interpreter or saved</span> <span class="c1"># and loaded in a Python-free environment</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">traced_foo</span><span class="p">,</span> <span class="s1">'foo.pt'</span><span class="p">)</span> <span class="n">traced_foo</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'foo.pt'</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="module-compilation"> <h3>Module Compilation<a class="headerlink" href="#module-compilation" title="Permalink to this headline">#</a></h3> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="k">class</span> <span class="nc">Net</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">(</span><span class="n">Net</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="n">n</span> <span class="o">=</span> <span class="n">Net</span><span class="p">()</span> <span class="n">n</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c1"># Trace a specific method and construct `ScriptModule` with</span> <span class="c1"># a single `forward` method</span> <span class="n">neuron_forward</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">n</span><span class="o">.</span><span class="n">forward</span><span class="p">,</span> <span class="n">inputs</span><span class="p">)</span> <span class="c1"># Trace a module (implicitly traces `forward`) and constructs a</span> <span class="c1"># `ScriptModule` with a single `forward` method</span> <span class="n">neuron_net</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">inputs</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="pre-trained-model-compilation"> <h3>Pre-Trained Model Compilation<a class="headerlink" href="#pre-trained-model-compilation" title="Permalink to this headline">#</a></h3> <p>The following is an example usage of the compilation Python API, with default compilation arguments, using a pretrained <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.Module</span></code></a>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="compiling-models-with-torch-jit-trace-kwargs"> <span id="compiling-models-with-kwargs"></span><h3>Compiling models with torch.jit.trace kwargs<a class="headerlink" href="#compiling-models-with-torch-jit-trace-kwargs" title="Permalink to this headline">#</a></h3> <p>This example uses the <code class="code docutils literal notranslate"><span class="pre">strict=False</span></code> flag to compile a model with dictionary outputs. Similarly, any other keyword argument of <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a> can be passed directly to <a class="reference internal" href="#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> so that it is passed to the underlying trace call.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">(</span><span class="n">Model</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="p">{</span><span class="s1">'conv'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">}</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Model</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c1"># use the strict=False kwarg to compile a model with dictionary outputs</span> <span class="c1"># the model output format does not change</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dynamic-batching"> <h3>Dynamic Batching<a class="headerlink" href="#dynamic-batching" title="Permalink to this headline">#</a></h3> <p>This example uses the optional <code class="code docutils literal notranslate"><span class="pre">dynamic_batch_size</span></code> option in order to support variable sized batches at inference time.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input of batch size 1</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">,</span> <span class="n">dynamic_batch_size</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># Execute with a batch of 7 images</span> <span class="n">batch</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">7</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">results</span> <span class="o">=</span> <span class="n">model_neuron</span><span class="p">(</span><span class="n">batch</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="manual-partitioning"> <h3>Manual Partitioning<a class="headerlink" href="#manual-partitioning" title="Permalink to this headline">#</a></h3> <p>The following example uses the optional <code class="code docutils literal notranslate"><span class="pre">subgraph_builder_function</span></code> parameter to ensure that only a specific convolution layer is compiled to Neuron. The remaining operations are executed on CPU.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="k">class</span> <span class="nc">ExampleConvolutionLayer</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">layer</span> <span class="o">=</span> <span class="n">ExampleConvolutionLayer</span><span class="p">()</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">layer</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">*</span> <span class="mi">100</span> <span class="k">def</span> <span class="nf">subgraph_builder_function</span><span class="p">(</span><span class="n">node</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span> <span class="w"> </span><span class="sd">"""Select if the node will be included in the Neuron graph"""</span> <span class="c1"># Node names are tuples of Module names.</span> <span class="k">if</span> <span class="s1">'ExampleConvolutionLayer'</span> <span class="ow">in</span> <span class="n">node</span><span class="o">.</span><span class="n">name</span><span class="p">:</span> <span class="k">return</span> <span class="kc">True</span> <span class="c1"># Ignore all operations not in the example convolution layer</span> <span class="k">return</span> <span class="kc">False</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Model</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c1"># Log output shows that `aten::_convolution` and `aten::add` are compiled</span> <span class="c1"># but `aten::mul` is not. This will seamlessly switch between Neuron/CPU</span> <span class="c1"># execution in a single graph.</span> <span class="n">neuron_model</span> <span class="o">=</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span> <span class="n">model</span><span class="p">,</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">subgraph_builder_function</span><span class="o">=</span><span class="n">subgraph_builder_function</span> <span class="p">)</span> </pre></div> </div> </div> <div class="section" id="separate-weights"> <h3>Separate Weights<a class="headerlink" href="#separate-weights" title="Permalink to this headline">#</a></h3> <p>This example uses the optional <code class="code docutils literal notranslate"><span class="pre">separate_weights</span></code> option in order to support compilation of models greater than 1.9GB.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1">#the models' output format does not change</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">,</span> <span class="n">separate_weights</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-reference-guide-torch-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">API Reference Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="api-torch-neuron-dataparallel-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">torch.neuron.DataParallel API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:57.315Z
API Reference Guide (torch-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html
# API Reference Guide (torch-neuron) — AWS Neuron Documentation previous Additional Examples (`torch-neuron`)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>API Reference Guide (torch-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="PyTorch-Neuron trace python API" href="api-compilation-python-api.html"> <link rel="prev" title="Additional Examples (torch-neuron)" href="additional-examples-inference-torch-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/api-reference-guide-torch-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/api-reference-guide-torch-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>API Reference Guide (torch-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="api-reference-guide-torch-neuron"> <h1>API Reference Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<a class="headerlink" href="#api-reference-guide-torch-neuron" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="api-compilation-python-api.html#torch-neuron-trace-api"><span class="std std-ref">PyTorch Neuron trace Python API</span></a></p></li> <li><p><a class="reference internal" href="api-torch-neuron-dataparallel-api.html#api-torch-neuron-dataparallel-api"><span class="std std-ref">torch.neuron.DataParallel API</span></a></p></li> <li><p><a class="reference internal" href="api-core-placement.html#torch-core-placement-api"><span class="std std-ref">PyTorch Neuron (torch-neuron) Core Placement API [Experimental]</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="additional-examples-inference-torch-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="api-compilation-python-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch-Neuron trace python API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:57.710Z
torch.neuron.DataParallel API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html
# torch.neuron.DataParallel API — AWS Neuron Documentation ## Contents - [Examples](#examples) - [Default usage](#default-usage) - [Specifying NeuronCores](#specifying-neuroncores) - [DataParallel with dim != 0](#dataparallel-with-dim-0) - [Dynamic batching](#dynamic-batching) - [Dynamic batching disabled](#dynamic-batching-disabled) - [Full tutorial with torch.neuron.DataParallel](#full-tutorial-with-torch-neuron-dataparallel) _This document is relevant for_: `Inf1` ## torch.neuron.DataParallel API[#](#torch-neuron-dataparallel-api "Permalink to this headline") The [`torch.neuron.DataParallel()`](#torch.neuron.DataParallel "torch.neuron.DataParallel") Python API implements data parallelism on [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") models created by the [PyTorch-Neuron trace python API](api-compilation-python-api.html#torch-neuron-trace-api). This function is analogous to [`DataParallel`](https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") in PyTorch. The [Data Parallel Inference on Torch Neuron](../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html#torch-neuron-dataparallel-app-note) application note provides an overview of how [`torch.neuron.DataParallel()`](#torch.neuron.DataParallel "torch.neuron.DataParallel") can be used to improve the performance of inference workloads on Inferentia. torch.neuron.DataParallel(_model_, _device\_ids\=None_, _dim\=0_)[#](#torch.neuron.DataParallel "Permalink to this definition") Applies data parallelism by replicating the model on available NeuronCores and distributing data across the different NeuronCores for parallelized inference. By default, DataParallel will use all available NeuronCores allocated for the current process for parallelism. DataParallel will apply parallelism on `dim=0` if `dim` is not specified. DataParallel automatically enables [dynamic batching](../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html#dynamic-batching-description) on eligible models if `dim=0`. Dynamic batching can be dsiabled using [`torch.neuron.DataParallel.disable_dynamic_batching()`](../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch.neuron.DataParallel.disable_dynamic_batching "torch.neuron.DataParallel.disable_dynamic_batching"). If dynamic batching is not enabled, the batch size at compilation-time must be equal to the batch size at inference-time divided by the number of NeuronCores being used. Specifically, the following must be true when dynamic batching is disabled: `input.shape[dim] / len(device_ids) == compilation_input.shape[dim]`. DataParallel will throw a warning if dynamic batching cannot be enabled. DataParallel will try load all of a model’s NEFFs onto a single NeuronCore, only if all of the NEFFs can fit on a single NeuronCore. DataParallel does not currently support models that have been compiled with [NeuronCore Pipeline](../../../general/arch/neuron-features/neuroncore-pipeline.html#neuroncore-pipeline). [`torch.neuron.DataParallel()`](#torch.neuron.DataParallel "torch.neuron.DataParallel") requires PyTorch >= 1.8. _Required Arguments_ Parameters **model** ([_ScriptModule_](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")) – Model created by the [PyTorch-Neuron trace python API](api-compilation-python-api.html#torch-neuron-trace-api) to be parallelized. _Optional Arguments_ Parameters - **device\_ids** ([_list_](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.11)")) – List of [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") or `'nc:#'` that specify the NeuronCores to use for parallelization (default: all NeuronCores). Refer to the [device\_ids note](#device-ids-note) for a description of how `device_ids` indexing works. - **dim** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – Dimension along which the input tensor is scattered across NeuronCores (default `dim=0`). _Attributes_ Parameters - **num\_workers** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – Number of worker threads used for multithreaded inference (default: `2 * number of NeuronCores`). - **split\_size** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – Size of the input chunks (default: `max(1, input.shape[dim] // number of NeuronCores)`). torch.neuron.DataParallel.disable\_dynamic\_batching()[#](#torch.neuron.DataParallel.disable_dynamic_batching "Permalink to this definition") Disables automatic dynamic batching on the DataParallel module. See [Dynamic batching disabled](#dataparallel-example-disable-dynamic-batching-api) for example of how DataParallel can be used with dynamic batching disabled. Use as follows: ``` >>> model_parallel = torch.neuron.DataParallel(model_neuron) >>> model_parallel.disable_dynamic_batching() ``` Note `device_ids` uses per-process NeuronCore granularity and zero-based indexing. Per-process granularity means that each Python process “sees” its own view of the world. Specifically, this means that `device_ids` only “sees” the NeuronCores that are allocated for the current process. Zero-based indexing means that each Python process will index its allocated NeuronCores starting at 0, regardless of the “global” index of the NeuronCores. Zero-based indexing makes it possible to redeploy the exact same code unchanged in different process. This behavior is analogous to the `device_ids` argument in the PyTorch [`DataParallel`](https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function. As an example, assume DataParallel is run on an inf1.6xlarge, which contains four Inferentia chips each of which contains four NeuronCores: - If `NEURON_RT_VISIBLE_CORES` is not set, a single process can access all 16 NeuronCores. Thus specifying `device_ids=["nc:0"]` will correspond to chip0:core0 and `device_ids=["nc:14"]` will correspond to chip3:core2. - However, if two processes are launched where: process 1 has `NEURON_RT_VISIBLE_CORES=0-6` and process 2 has `NEURON_RT_VISIBLE_CORES=7-15`, `device_ids=["nc:14"]` cannot be specified in either process. Instead, chip3:core2 can only be accessed in process 2. Additionally, chip3:core2 is specified in process 2 with `device_ids=["nc:7"]`. Furthermore, in process 1, `device_ids=["nc:0"]` would correspond to chip0:core0; in process 2 `device_ids=["nc:0"]` would correspond to chip1:core3. ## Examples[#](#examples "Permalink to this headline") The following sections provide example usages of the [`torch.neuron.DataParallel()`](#torch.neuron.DataParallel "torch.neuron.DataParallel") module. ### Default usage[#](#default-usage "Permalink to this headline") The default DataParallel use mode will replicate the model on all available NeuronCores in the current process. The inputs will be split on `dim=0`. ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module model_parallel = torch.neuron.DataParallel(model_neuron) # Create a batched input batch_size = 5 image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### Specifying NeuronCores[#](#specifying-neuroncores "Permalink to this headline") The following example uses the `device_ids` argument to use the first three NeuronCores for DataParallel inference. ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module, run on the first three NeuronCores # Equivalent to model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1, 2]) model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=['nc:0', 'nc:1', 'nc:2']) # Create a batched input batch_size = 5 image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### DataParallel with dim != 0[#](#dataparallel-with-dim-0 "Permalink to this headline") In this example we run DataParallel inference using four NeuronCores and `dim = 2`. Because `dim != 0`, dynamic batching is not enabled. Consequently, the DataParallel inference-time batch size must be four times the compile-time batch size. DataParallel will generate a warning that dynamic batching is disabled because `dim != 0`. ``` import torch import torch_neuron # Create an example model class Model(torch.nn.Module): def __init__(self): super().__init__() self.conv = torch.nn.Conv2d(3, 3, 3) def forward(self, x): return self.conv(x) + 1 model = Model() model.eval() # Compile with an example input image = torch.rand([1, 3, 8, 8]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module using 4 NeuronCores and dim = 2 model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1, 2, 3], dim=2) # Create a batched input # Note that image_batched.shape[dim] / len(device_ids) == image.shape[dim] batch_size = 4 * 8 image_batched = torch.rand([1, 3, batch_size, 8]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### Dynamic batching[#](#dynamic-batching "Permalink to this headline") In the following example, we use the [`torch.neuron.DataParallel()`](#torch.neuron.DataParallel "torch.neuron.DataParallel") module to run inference using several different batch sizes without recompiling the Neuron model. ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module model_parallel = torch.neuron.DataParallel(model_neuron) # Create batched inputs and run inference on the same model batch_sizes = [2, 3, 4, 5, 6] for batch_size in batch_sizes: image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### Dynamic batching disabled[#](#dynamic-batching-disabled "Permalink to this headline") In the following example, we use [`torch.neuron.DataParallel.disable_dynamic_batching()`](../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch.neuron.DataParallel.disable_dynamic_batching "torch.neuron.DataParallel.disable_dynamic_batching") to disable dynamic batching. We provide an example of a batch size that will not work when dynamic batching is disabled as well as an example of a batch size that does work when dynamic batching is disabled. ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module and use 4 NeuronCores model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1, 2, 3], dim=0) # Disable dynamic batching model_parallel.disable_dynamic_batching() # Create a batched input (this won't work) batch_size = 8 image_batched = torch.rand([batch_size, 3, 224, 224]) # This will fail because dynamic batching is disabled and # image_batched.shape[dim] / len(device_ids) != image.shape[dim] # output = model_parallel(image_batched) # Create a batched input (this will work) batch_size = 4 image_batched = torch.rand([batch_size, 3, 224, 224]) # This will work because # image_batched.shape[dim] / len(device_ids) == image.shape[dim] output = model_parallel(image_batched) ``` ### Full tutorial with torch.neuron.DataParallel[#](#full-tutorial-with-torch-neuron-dataparallel "Permalink to this headline") For an end-to-end tutorial that uses DataParallel, see the [PyTorch Resnet Tutorial](../../../src/examples/pytorch/resnet50.html). _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>torch.neuron.DataParallel API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuron) Core Placement API [Experimental]" href="api-core-placement.html"> <link rel="prev" title="PyTorch-Neuron trace python API" href="api-compilation-python-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-usage"> Default usage </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#specifying-neuroncores"> Specifying NeuronCores </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-with-dim-0"> DataParallel with dim != 0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching-disabled"> Dynamic batching disabled </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#full-tutorial-with-torch-neuron-dataparallel"> Full tutorial with torch.neuron.DataParallel </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>torch.neuron.DataParallel API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-usage"> Default usage </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#specifying-neuroncores"> Specifying NeuronCores </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-with-dim-0"> DataParallel with dim != 0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching-disabled"> Dynamic batching disabled </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#full-tutorial-with-torch-neuron-dataparallel"> Full tutorial with torch.neuron.DataParallel </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="torch-neuron-dataparallel-api"> <span id="api-torch-neuron-dataparallel-api"></span><h1>torch.neuron.DataParallel API<a class="headerlink" href="#torch-neuron-dataparallel-api" title="Permalink to this headline">#</a></h1> <p>The <a class="reference internal" href="#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> Python API implements data parallelism on <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> models created by the <a class="reference internal" href="api-compilation-python-api.html#torch-neuron-trace-api"><span class="std std-ref">PyTorch-Neuron trace python API</span></a>. This function is analogous to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParallel</span></code></a> in PyTorch. The <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html#torch-neuron-dataparallel-app-note"><span class="std std-ref">Data Parallel Inference on Torch Neuron</span></a> application note provides an overview of how <a class="reference internal" href="#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> can be used to improve the performance of inference workloads on Inferentia.</p> <dl class="py function"> <dt class="sig sig-object py" id="torch.neuron.DataParallel"> <span class="sig-prename descclassname"><span class="pre">torch.neuron.</span></span><span class="sig-name descname"><span class="pre">DataParallel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch.neuron.DataParallel" title="Permalink to this definition">#</a></dt> <dd><p>Applies data parallelism by replicating the model on available NeuronCores and distributing data across the different NeuronCores for parallelized inference.</p> <p>By default, DataParallel will use all available NeuronCores allocated for the current process for parallelism. DataParallel will apply parallelism on <code class="docutils literal notranslate"><span class="pre">dim=0</span></code> if <code class="docutils literal notranslate"><span class="pre">dim</span></code> is not specified.</p> <p>DataParallel automatically enables <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html#dynamic-batching-description"><span class="std std-ref">dynamic batching</span></a> on eligible models if <code class="docutils literal notranslate"><span class="pre">dim=0</span></code>. Dynamic batching can be dsiabled using <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch.neuron.DataParallel.disable_dynamic_batching" title="torch.neuron.DataParallel.disable_dynamic_batching"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel.disable_dynamic_batching()</span></code></a>. If dynamic batching is not enabled, the batch size at compilation-time must be equal to the batch size at inference-time divided by the number of NeuronCores being used. Specifically, the following must be true when dynamic batching is disabled: <code class="docutils literal notranslate"><span class="pre">input.shape[dim]</span> <span class="pre">/</span> <span class="pre">len(device_ids)</span> <span class="pre">==</span> <span class="pre">compilation_input.shape[dim]</span></code>. DataParallel will throw a warning if dynamic batching cannot be enabled.</p> <p>DataParallel will try load all of a model’s NEFFs onto a single NeuronCore, only if all of the NEFFs can fit on a single NeuronCore. DataParallel does not currently support models that have been compiled with <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html#neuroncore-pipeline"><span class="std std-ref">NeuronCore Pipeline</span></a>.</p> <p><a class="reference internal" href="#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> requires PyTorch &gt;= 1.8.</p> <p><em>Required Arguments</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>model</strong> (<a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><em>ScriptModule</em></a>) – Model created by the <a class="reference internal" href="api-compilation-python-api.html#torch-neuron-trace-api"><span class="std std-ref">PyTorch-Neuron trace python API</span></a> to be parallelized.</p> </dd> </dl> <p><em>Optional Arguments</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>device_ids</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><em>list</em></a>) – List of <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> or <code class="docutils literal notranslate"><span class="pre">'nc:#'</span></code> that specify the NeuronCores to use for parallelization (default: all NeuronCores). Refer to the <a class="reference internal" href="#device-ids-note"><span class="std std-ref">device_ids note</span></a> for a description of how <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> indexing works.</p></li> <li><p><strong>dim</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Dimension along which the input tensor is scattered across NeuronCores (default <code class="docutils literal notranslate"><span class="pre">dim=0</span></code>).</p></li> </ul> </dd> </dl> <p><em>Attributes</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>num_workers</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Number of worker threads used for multithreaded inference (default: <code class="docutils literal notranslate"><span class="pre">2</span> <span class="pre">*</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">NeuronCores</span></code>).</p></li> <li><p><strong>split_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Size of the input chunks (default: <code class="docutils literal notranslate"><span class="pre">max(1,</span> <span class="pre">input.shape[dim]</span> <span class="pre">//</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">NeuronCores)</span></code>).</p></li> </ul> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="torch.neuron.DataParallel.disable_dynamic_batching"> <span class="sig-prename descclassname"><span class="pre">torch.neuron.DataParallel.</span></span><span class="sig-name descname"><span class="pre">disable_dynamic_batching</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#torch.neuron.DataParallel.disable_dynamic_batching" title="Permalink to this definition">#</a></dt> <dd><p>Disables automatic dynamic batching on the DataParallel module. See <a class="reference internal" href="#dataparallel-example-disable-dynamic-batching-api"><span class="std std-ref">Dynamic batching disabled</span></a> for example of how DataParallel can be used with dynamic batching disabled. Use as follows:</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model_parallel</span><span class="o">.</span><span class="n">disable_dynamic_batching</span><span class="p">()</span> </pre></div> </div> </dd></dl> <div class="admonition note" id="device-ids-note"> <p class="admonition-title">Note</p> <p><code class="docutils literal notranslate"><span class="pre">device_ids</span></code> uses per-process NeuronCore granularity and zero-based indexing. Per-process granularity means that each Python process “sees” its own view of the world. Specifically, this means that <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> only “sees” the NeuronCores that are allocated for the current process. Zero-based indexing means that each Python process will index its allocated NeuronCores starting at 0, regardless of the “global” index of the NeuronCores. Zero-based indexing makes it possible to redeploy the exact same code unchanged in different process. This behavior is analogous to the <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument in the PyTorch <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParallel</span></code></a> function.</p> <p>As an example, assume DataParallel is run on an inf1.6xlarge, which contains four Inferentia chips each of which contains four NeuronCores:</p> <ul class="simple"> <li><p>If <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code> is not set, a single process can access all 16 NeuronCores. Thus specifying <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:0"]</span></code> will correspond to chip0:core0 and <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:14"]</span></code> will correspond to chip3:core2.</p></li> <li><p>However, if two processes are launched where: process 1 has <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES=0-6</span></code> and process 2 has <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES=7-15</span></code>, <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:14"]</span></code> cannot be specified in either process. Instead, chip3:core2 can only be accessed in process 2. Additionally, chip3:core2 is specified in process 2 with <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:7"]</span></code>. Furthermore, in process 1, <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:0"]</span></code> would correspond to chip0:core0; in process 2 <code class="docutils literal notranslate"><span class="pre">device_ids=["nc:0"]</span></code> would correspond to chip1:core3.</p></li> </ul> </div> <div class="section" id="examples"> <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">#</a></h2> <p>The following sections provide example usages of the <a class="reference internal" href="#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> module.</p> <div class="section" id="default-usage"> <h3>Default usage<a class="headerlink" href="#default-usage" title="Permalink to this headline">#</a></h3> <p>The default DataParallel use mode will replicate the model on all available NeuronCores in the current process. The inputs will be split on <code class="docutils literal notranslate"><span class="pre">dim=0</span></code>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="c1"># Create a batched input</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">5</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="specifying-neuroncores"> <h3>Specifying NeuronCores<a class="headerlink" href="#specifying-neuroncores" title="Permalink to this headline">#</a></h3> <p>The following example uses the <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument to use the first three NeuronCores for DataParallel inference.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module, run on the first three NeuronCores</span> <span class="c1"># Equivalent to model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1, 2])</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="s1">'nc:0'</span><span class="p">,</span> <span class="s1">'nc:1'</span><span class="p">,</span> <span class="s1">'nc:2'</span><span class="p">])</span> <span class="c1"># Create a batched input</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">5</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dataparallel-with-dim-0"> <h3>DataParallel with dim != 0<a class="headerlink" href="#dataparallel-with-dim-0" title="Permalink to this headline">#</a></h3> <p>In this example we run DataParallel inference using four NeuronCores and <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">=</span> <span class="pre">2</span></code>. Because <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">!=</span> <span class="pre">0</span></code>, dynamic batching is not enabled. Consequently, the DataParallel inference-time batch size must be four times the compile-time batch size. DataParallel will generate a warning that dynamic batching is disabled because <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">!=</span> <span class="pre">0</span></code>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="c1"># Create an example model</span> <span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Model</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">8</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module using 4 NeuronCores and dim = 2</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="c1"># Create a batched input</span> <span class="c1"># Note that image_batched.shape[dim] / len(device_ids) == image.shape[dim]</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">4</span> <span class="o">*</span> <span class="mi">8</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="mi">8</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dynamic-batching"> <h3>Dynamic batching<a class="headerlink" href="#dynamic-batching" title="Permalink to this headline">#</a></h3> <p>In the following example, we use the <a class="reference internal" href="#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> module to run inference using several different batch sizes without recompiling the Neuron model.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="c1"># Create batched inputs and run inference on the same model</span> <span class="n">batch_sizes</span> <span class="o">=</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]</span> <span class="k">for</span> <span class="n">batch_size</span> <span class="ow">in</span> <span class="n">batch_sizes</span><span class="p">:</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dynamic-batching-disabled"> <span id="dataparallel-example-disable-dynamic-batching-api"></span><h3>Dynamic batching disabled<a class="headerlink" href="#dynamic-batching-disabled" title="Permalink to this headline">#</a></h3> <p>In the following example, we use <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch.neuron.DataParallel.disable_dynamic_batching" title="torch.neuron.DataParallel.disable_dynamic_batching"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel.disable_dynamic_batching()</span></code></a> to disable dynamic batching. We provide an example of a batch size that will not work when dynamic batching is disabled as well as an example of a batch size that does work when dynamic batching is disabled.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module and use 4 NeuronCores</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># Disable dynamic batching</span> <span class="n">model_parallel</span><span class="o">.</span><span class="n">disable_dynamic_batching</span><span class="p">()</span> <span class="c1"># Create a batched input (this won't work)</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">8</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># This will fail because dynamic batching is disabled and</span> <span class="c1"># image_batched.shape[dim] / len(device_ids) != image.shape[dim]</span> <span class="c1"># output = model_parallel(image_batched)</span> <span class="c1"># Create a batched input (this will work)</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># This will work because</span> <span class="c1"># image_batched.shape[dim] / len(device_ids) == image.shape[dim]</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="full-tutorial-with-torch-neuron-dataparallel"> <h3>Full tutorial with torch.neuron.DataParallel<a class="headerlink" href="#full-tutorial-with-torch-neuron-dataparallel" title="Permalink to this headline">#</a></h3> <p>For an end-to-end tutorial that uses DataParallel, see the <a class="reference internal" href="../../../src/examples/pytorch/resnet50.html"><span class="std std-ref">PyTorch Resnet Tutorial</span></a>.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-compilation-python-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch-Neuron trace python API</p> </div> </a> <a class="right-next" id="next-link" href="api-core-placement.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Core Placement API [Experimental]</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:58.166Z
PyTorch Neuron (torch-neuron) Core Placement API [Experimental] — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/api-core-placement.html
# PyTorch Neuron (torch-neuron) Core Placement API \[Experimental\] — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf1` ## PyTorch Neuron (`torch-neuron`) Core Placement API \[Experimental\][#](#module-placement "Permalink to this headline") Warning The following functionality is experimental and **will not be supported** in future releases of the NeuronSDK. This module serves only as a preview for future functionality. In future releases, equivalent functionality may be moved directly to the `torch_neuron` module and will no longer be available in the `torch_neuron.experimental` module. Functions which enable placement of [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to specific NeuronCores. Two sets of functions are provided which can be used interchangeably but have different performance characteristics and advantages: - The [`multicore_context()`](#placement.torch_neuron.experimental.multicore_context "placement.torch_neuron.experimental.multicore_context") & [`neuron_cores_context()`](#placement.torch_neuron.experimental.neuron_cores_context "placement.torch_neuron.experimental.neuron_cores_context") functions are context managers that allow a model to be placed on a given NeuronCore at [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") time. These functions are the most efficient way of loading a model since the model is loaded directly to a NeuronCore. The alternative functions described below require that a model is unloaded from one core and then reloaded to another. - The [`set_multicore()`](#placement.torch_neuron.experimental.set_multicore "placement.torch_neuron.experimental.set_multicore") & [`set_neuron_cores()`](#placement.torch_neuron.experimental.set_neuron_cores "placement.torch_neuron.experimental.set_neuron_cores") functions allow a model that has already been loaded to a NeuronCore to be moved to a different NeuronCore. This functionality is less efficient than directly loading a model to a NeuronCore within a context manager but allows device placement to be fully dynamic at runtime. This is analogous to the [`torch.nn.Module.to()`](https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module.to "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function for device placement. torch\_neuron.experimental.multicore\_context()[#](#placement.torch_neuron.experimental.multicore_context "Permalink to this definition") A context which loads all Neuron subgraphs to all visible NeuronCores. This loads each Neuron subgraph within a [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to multiple NeuronCores without requiring multiple calls to [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use multiple NeuronCores for concurrent threadsafe inferences. Executions use a round-robin strategy to distribute across NeuronCores. Any calls to [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") will cause any underlying Neuron subgraphs to load to the specified NeuronCores within this context. This context manager only needs to be used during the model load. After loading, inferences do not need to occur in this context in order to use the correct NeuronCores. Note that this context is _not_ threadsafe. Using multiple core placement contexts from multiple threads may not correctly place models. Raises [**RuntimeError**](https://docs.python.org/3/library/exceptions.html#RuntimeError "(in Python v3.11)") – If the Neuron runtime cannot be initialized. Examples _Multiple Core Replication_: Directly load a model to all visible NeuronCores. This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use all NeuronCores by running round-robin executions. ``` >>> with torch_neuron.experimental.multicore_context(): >>> model = torch.jit.load('example_neuron_model.pt') >>> model(example) # Executes on NeuronCore 0 >>> model(example) # Executes on NeuronCore 1 >>> model(example) # Executes on NeuronCore 2 ``` torch\_neuron.experimental.neuron\_cores\_context(_start\_nc: [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") \= \- 1_, _nc\_count: [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") \= \- 1_)[#](#placement.torch_neuron.experimental.neuron_cores_context "Permalink to this definition") A context which sets the NeuronCore start/count for all Neuron subgraphs. Any calls to [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") will cause any underlying Neuron subgraphs to load to the specified NeuronCores within this context. This context manager only needs to be used during the model load. After loading, inferences do not need to occur in this context in order to use the correct NeuronCores. Note that this context is _not_ threadsafe. Using multiple core placement contexts from multiple threads may not correctly place models. Parameters - **start\_nc** – The starting NeuronCore index where the Module is placed. The value `-1` automatically loads to the optimal NeuronCore (least used). Note that this index is always relative to NeuronCores visible to this process. - **nc\_count** – The number of NeuronCores to use. The value `-1` will load a model to exactly the number of cores required by that model (1 for most models, >1 when using NeuronCore Pipeline). If `nc_count` is greater than the number of NeuronCores required by the model, the model will be replicated across multiple NeuronCores. `(replications = floor(nc_count / cores_per_model))` Raises - [**RuntimeError**](https://docs.python.org/3/library/exceptions.html#RuntimeError "(in Python v3.11)") – If the Neuron runtime cannot be initialized. - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.11)") – If the `nc_count` is an invalid number of NeuronCores. Examples _Single Load_: Directly load a model from disk to the first visible NeuronCore. ``` >>> with torch_neuron.experimental.neuron_cores_context(start_nc=0, nc_count=1): >>> model = torch.jit.load('example_neuron_model.pt') >>> model(example) # Executes on NeuronCore 0 >>> model(example) # Executes on NeuronCore 0 >>> model(example) # Executes on NeuronCore 0 ``` _Multiple Core Replication_: Directly load a model from disk to 2 NeuronCores. This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use multiple NeuronCores by running round-robin executions. ``` >>> with torch_neuron.experimental.neuron_cores_context(start_nc=2, nc_count=2): >>> model = torch.jit.load('example_neuron_model.pt') >>> model(example) # Executes on NeuronCore 2 >>> model(example) # Executes on NeuronCore 3 >>> model(example) # Executes on NeuronCore 2 ``` _Multiple Model Load_: Directly load 2 models from disk and pin them to separate NeuronCores. This causes each [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to always execute on a specific NeuronCore. ``` >>> with torch_neuron.experimental.neuron_cores_context(start_nc=2): >>> model1 = torch.jit.load('example_neuron_model.pt') >>> with torch_neuron.experimental.neuron_cores_context(start_nc=0): >>> model2 = torch.jit.load('example_neuron_model.pt') >>> model1(example) # Executes on NeuronCore 2 >>> model1(example) # Executes on NeuronCore 2 >>> model2(example) # Executes on NeuronCore 0 >>> model2(example) # Executes on NeuronCore 0 ``` torch\_neuron.experimental.set\_multicore(_trace: [torch.jit.ScriptModule](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_)[#](#placement.torch_neuron.experimental.set_multicore "Permalink to this definition") Loads all Neuron subgraphs in a torch Module to all visible NeuronCores. This loads each Neuron subgraph within a [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to multiple NeuronCores without requiring multiple calls to [`torch.jit.load()`](https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use multiple NeuronCores for concurrent threadsafe inferences. Executions use a round-robin strategy to distribute across NeuronCores. This will unload the model from an existing NeuronCore if it is already loaded. _Requires Torch 1.8+_ Parameters **trace** – A torch module which contains one or more Neuron subgraphs. Raises [**RuntimeError**](https://docs.python.org/3/library/exceptions.html#RuntimeError "(in Python v3.11)") – If the Neuron runtime cannot be initialized. Examples _Multiple Core Replication_: Move a model across all visible NeuronCores after loading. This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use all NeuronCores by running round-robin executions. ``` >>> model = torch.jit.load('example_neuron_model.pt') >>> torch_neuron.experimental.set_multicore(model) >>> model(example) # Executes on NeuronCore 0 >>> model(example) # Executes on NeuronCore 1 >>> model(example) # Executes on NeuronCore 2 ``` torch\_neuron.experimental.set\_neuron\_cores(_trace: [torch.jit.ScriptModule](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))")_, _start\_nc: [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") \= \- 1_, _nc\_count: [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") \= \- 1_)[#](#placement.torch_neuron.experimental.set_neuron_cores "Permalink to this definition") Set the NeuronCore start/count for all Neuron subgraphs in a torch Module. This will unload the model from an existing NeuronCore if it is already loaded. _Requires Torch 1.8+_ Parameters - **trace** – A torch module which contains one or more Neuron subgraphs. - **start\_nc** – The starting NeuronCore index where the Module is placed. The value `-1` automatically loads to the optimal NeuronCore (least used). Note that this index is always relative to NeuronCores visible to this process. - **nc\_count** – The number of NeuronCores to use. The value `-1` will load a model to exactly the number of cores required by that model (1 for most models, >1 when using NeuronCore Pipeline). If `nc_count` is greater than the number of NeuronCores required by the model, the model will be replicated across multiple NeuronCores. `(replications = floor(nc_count / cores_per_model))` Raises - [**RuntimeError**](https://docs.python.org/3/library/exceptions.html#RuntimeError "(in Python v3.11)") – If the Neuron runtime cannot be initialized. - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.11)") – If the `nc_count` is an invalid number of NeuronCores. Examples _Single Load_: Move a model to the first visible NeuronCore after loading. ``` >>> model = torch.jit.load('example_neuron_model.pt') >>> torch_neuron.experimental.set_neuron_cores(model, start_nc=0, nc_count=1) >>> model(example) # Executes on NeuronCore 0 >>> model(example) # Executes on NeuronCore 0 >>> model(example) # Executes on NeuronCore 0 ``` _Multiple Core Replication_: Replicate a model to 2 NeuronCores after loading. This allows a single [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to use multiple NeuronCores by running round-robin executions. ``` >>> model = torch.jit.load('example_neuron_model.pt') >>> torch_neuron.experimental.set_neuron_cores(model, start_nc=2, nc_count=2) >>> model(example) # Executes on NeuronCore 2 >>> model(example) # Executes on NeuronCore 3 >>> model(example) # Executes on NeuronCore 2 ``` _Multiple Model Load_: Move and pin 2 models to separate NeuronCores. This causes each [`torch.jit.ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to always execute on a specific NeuronCore. ``` >>> model1 = torch.jit.load('example_neuron_model.pt') >>> torch_neuron.experimental.set_neuron_cores(model1, start_nc=2) >>> model2 = torch.jit.load('example_neuron_model.pt') >>> torch_neuron.experimental.set_neuron_cores(model2, start_nc=0) >>> model1(example) # Executes on NeuronCore 2 >>> model1(example) # Executes on NeuronCore 2 >>> model2(example) # Executes on NeuronCore 0 >>> model2(example) # Executes on NeuronCore 0 ``` _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuron) Core Placement API [Experimental] — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Developer Guide (torch-neuron)" href="developer-guide-torch-neuron.html"> <link rel="prev" title="torch.neuron.DataParallel API" href="api-torch-neuron-dataparallel-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/api-core-placement", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/api-core-placement.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/api-core-placement.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuron/api-core-placement.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuron) Core Placement API [Experimental]</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="module-placement"> <span id="pytorch-neuron-torch-neuron-core-placement-api-experimental"></span><span id="torch-core-placement-api"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Core Placement API [Experimental]<a class="headerlink" href="#module-placement" title="Permalink to this headline">#</a></h1> <div class="admonition warning"> <p class="admonition-title">Warning</p> <p>The following functionality is experimental and <strong>will not be supported</strong> in future releases of the NeuronSDK. This module serves only as a preview for future functionality. In future releases, equivalent functionality may be moved directly to the <code class="code docutils literal notranslate"><span class="pre">torch_neuron</span></code> module and will no longer be available in the <code class="code docutils literal notranslate"><span class="pre">torch_neuron.experimental</span></code> module.</p> </div> <p>Functions which enable placement of <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to specific NeuronCores. Two sets of functions are provided which can be used interchangeably but have different performance characteristics and advantages:</p> <ul class="simple"> <li><p>The <a class="reference internal" href="#placement.torch_neuron.experimental.multicore_context" title="placement.torch_neuron.experimental.multicore_context"><code class="xref py py-func docutils literal notranslate"><span class="pre">multicore_context()</span></code></a> &amp; <a class="reference internal" href="#placement.torch_neuron.experimental.neuron_cores_context" title="placement.torch_neuron.experimental.neuron_cores_context"><code class="xref py py-func docutils literal notranslate"><span class="pre">neuron_cores_context()</span></code></a> functions are context managers that allow a model to be placed on a given NeuronCore at <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a> time. These functions are the most efficient way of loading a model since the model is loaded directly to a NeuronCore. The alternative functions described below require that a model is unloaded from one core and then reloaded to another.</p></li> <li><p>The <a class="reference internal" href="#placement.torch_neuron.experimental.set_multicore" title="placement.torch_neuron.experimental.set_multicore"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_multicore()</span></code></a> &amp; <a class="reference internal" href="#placement.torch_neuron.experimental.set_neuron_cores" title="placement.torch_neuron.experimental.set_neuron_cores"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_neuron_cores()</span></code></a> functions allow a model that has already been loaded to a NeuronCore to be moved to a different NeuronCore. This functionality is less efficient than directly loading a model to a NeuronCore within a context manager but allows device placement to be fully dynamic at runtime. This is analogous to the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module.to" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-meth docutils literal notranslate"><span class="pre">torch.nn.Module.to()</span></code></a> function for device placement.</p></li> </ul> <div class="admonition important"> <p class="admonition-title">Important</p> <p>A prerequisite to enable placement functionality is that the loaded <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> has already been compiled with the <a class="reference internal" href="api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> API. Attempting to place a regular <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Module.html#torch.nn.Module" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.Module</span></code></a> onto a NeuronCore prior to compilation will do nothing.</p> </div> <dl class="py function"> <dt class="sig sig-object py" id="placement.torch_neuron.experimental.multicore_context"> <span class="sig-prename descclassname"><span class="pre">torch_neuron.experimental.</span></span><span class="sig-name descname"><span class="pre">multicore_context</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#placement.torch_neuron.experimental.multicore_context" title="Permalink to this definition">#</a></dt> <dd><p>A context which loads all Neuron subgraphs to all visible NeuronCores.</p> <p>This loads each Neuron subgraph within a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to multiple NeuronCores without requiring multiple calls to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use multiple NeuronCores for concurrent threadsafe inferences. Executions use a round-robin strategy to distribute across NeuronCores.</p> <p>Any calls to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a> will cause any underlying Neuron subgraphs to load to the specified NeuronCores within this context. This context manager only needs to be used during the model load. After loading, inferences do not need to occur in this context in order to use the correct NeuronCores.</p> <p>Note that this context is <em>not</em> threadsafe. Using multiple core placement contexts from multiple threads may not correctly place models.</p> <dl class="field-list simple"> <dt class="field-odd">Raises</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a> – If the Neuron runtime cannot be initialized.</p> </dd> </dl> <p class="rubric">Examples</p> <p><em>Multiple Core Replication</em>: Directly load a model to all visible NeuronCores. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use all NeuronCores by running round-robin executions.</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">multicore_context</span><span class="p">():</span> <span class="gp">&gt;&gt;&gt; </span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 1</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> </pre></div> </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="placement.torch_neuron.experimental.neuron_cores_context"> <span class="sig-prename descclassname"><span class="pre">torch_neuron.experimental.</span></span><span class="sig-name descname"><span class="pre">neuron_cores_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start_nc</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nc_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#placement.torch_neuron.experimental.neuron_cores_context" title="Permalink to this definition">#</a></dt> <dd><p>A context which sets the NeuronCore start/count for all Neuron subgraphs.</p> <p>Any calls to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a> will cause any underlying Neuron subgraphs to load to the specified NeuronCores within this context. This context manager only needs to be used during the model load. After loading, inferences do not need to occur in this context in order to use the correct NeuronCores.</p> <p>Note that this context is <em>not</em> threadsafe. Using multiple core placement contexts from multiple threads may not correctly place models.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>start_nc</strong> – The starting NeuronCore index where the Module is placed. The value <code class="docutils literal notranslate"><span class="pre">-1</span></code> automatically loads to the optimal NeuronCore (least used). Note that this index is always relative to NeuronCores visible to this process.</p></li> <li><p><strong>nc_count</strong> – The number of NeuronCores to use. The value <code class="docutils literal notranslate"><span class="pre">-1</span></code> will load a model to exactly the number of cores required by that model (1 for most models, &gt;1 when using NeuronCore Pipeline). If <code class="docutils literal notranslate"><span class="pre">nc_count</span></code> is greater than the number of NeuronCores required by the model, the model will be replicated across multiple NeuronCores. <code class="docutils literal notranslate"><span class="pre">(replications</span> <span class="pre">=</span> <span class="pre">floor(nc_count</span> <span class="pre">/</span> <span class="pre">cores_per_model))</span></code></p></li> </ul> </dd> <dt class="field-even">Raises</dt> <dd class="field-even"><ul class="simple"> <li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a> – If the Neuron runtime cannot be initialized.</p></li> <li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a> – If the <code class="docutils literal notranslate"><span class="pre">nc_count</span></code> is an invalid number of NeuronCores.</p></li> </ul> </dd> </dl> <p class="rubric">Examples</p> <p><em>Single Load</em>: Directly load a model from disk to the first visible NeuronCore.</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span> <span class="gp">&gt;&gt;&gt; </span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> </pre></div> </div> <p><em>Multiple Core Replication</em>: Directly load a model from disk to 2 NeuronCores. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use multiple NeuronCores by running round-robin executions.</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span> <span class="gp">&gt;&gt;&gt; </span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 3</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> </pre></div> </div> <p><em>Multiple Model Load</em>: Directly load 2 models from disk and pin them to separate NeuronCores. This causes each <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to always execute on a specific NeuronCore.</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span> <span class="gp">&gt;&gt;&gt; </span> <span class="n">model1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span> <span class="gp">&gt;&gt;&gt; </span> <span class="n">model2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model2</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model2</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> </pre></div> </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="placement.torch_neuron.experimental.set_multicore"> <span class="sig-prename descclassname"><span class="pre">torch_neuron.experimental.</span></span><span class="sig-name descname"><span class="pre">set_multicore</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><span class="pre">torch.jit.ScriptModule</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#placement.torch_neuron.experimental.set_multicore" title="Permalink to this definition">#</a></dt> <dd><p>Loads all Neuron subgraphs in a torch Module to all visible NeuronCores.</p> <p>This loads each Neuron subgraph within a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to multiple NeuronCores without requiring multiple calls to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.load.html#torch.jit.load" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.load()</span></code></a>. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use multiple NeuronCores for concurrent threadsafe inferences. Executions use a round-robin strategy to distribute across NeuronCores.</p> <p>This will unload the model from an existing NeuronCore if it is already loaded.</p> <p><em>Requires Torch 1.8+</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>trace</strong> – A torch module which contains one or more Neuron subgraphs.</p> </dd> <dt class="field-even">Raises</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a> – If the Neuron runtime cannot be initialized.</p> </dd> </dl> <p class="rubric">Examples</p> <p><em>Multiple Core Replication</em>: Move a model across all visible NeuronCores after loading. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use all NeuronCores by running round-robin executions.</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_multicore</span><span class="p">(</span><span class="n">model</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 1</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> </pre></div> </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="placement.torch_neuron.experimental.set_neuron_cores"> <span class="sig-prename descclassname"><span class="pre">torch_neuron.experimental.</span></span><span class="sig-name descname"><span class="pre">set_neuron_cores</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><span class="pre">torch.jit.ScriptModule</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_nc</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nc_count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#placement.torch_neuron.experimental.set_neuron_cores" title="Permalink to this definition">#</a></dt> <dd><p>Set the NeuronCore start/count for all Neuron subgraphs in a torch Module.</p> <p>This will unload the model from an existing NeuronCore if it is already loaded.</p> <p><em>Requires Torch 1.8+</em></p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>trace</strong> – A torch module which contains one or more Neuron subgraphs.</p></li> <li><p><strong>start_nc</strong> – The starting NeuronCore index where the Module is placed. The value <code class="docutils literal notranslate"><span class="pre">-1</span></code> automatically loads to the optimal NeuronCore (least used). Note that this index is always relative to NeuronCores visible to this process.</p></li> <li><p><strong>nc_count</strong> – The number of NeuronCores to use. The value <code class="docutils literal notranslate"><span class="pre">-1</span></code> will load a model to exactly the number of cores required by that model (1 for most models, &gt;1 when using NeuronCore Pipeline). If <code class="docutils literal notranslate"><span class="pre">nc_count</span></code> is greater than the number of NeuronCores required by the model, the model will be replicated across multiple NeuronCores. <code class="docutils literal notranslate"><span class="pre">(replications</span> <span class="pre">=</span> <span class="pre">floor(nc_count</span> <span class="pre">/</span> <span class="pre">cores_per_model))</span></code></p></li> </ul> </dd> <dt class="field-even">Raises</dt> <dd class="field-even"><ul class="simple"> <li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a> – If the Neuron runtime cannot be initialized.</p></li> <li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a> – If the <code class="docutils literal notranslate"><span class="pre">nc_count</span></code> is an invalid number of NeuronCores.</p></li> </ul> </dd> </dl> <p class="rubric">Examples</p> <p><em>Single Load</em>: Move a model to the first visible NeuronCore after loading.</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_neuron_cores</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">start_nc</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> </pre></div> </div> <p><em>Multiple Core Replication</em>: Replicate a model to 2 NeuronCores after loading. This allows a single <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to use multiple NeuronCores by running round-robin executions.</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_neuron_cores</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">start_nc</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 3</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> </pre></div> </div> <p><em>Multiple Model Load</em>: Move and pin 2 models to separate NeuronCores. This causes each <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.jit.ScriptModule</span></code></a> to always execute on a specific NeuronCore.</p> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">model1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_neuron_cores</span><span class="p">(</span><span class="n">model1</span><span class="p">,</span> <span class="n">start_nc</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'example_neuron_model.pt'</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">set_neuron_cores</span><span class="p">(</span><span class="n">model2</span><span class="p">,</span> <span class="n">start_nc</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model1</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 2</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model2</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model2</span><span class="p">(</span><span class="n">example</span><span class="p">)</span> <span class="c1"># Executes on NeuronCore 0</span> </pre></div> </div> </dd></dl> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-torch-neuron-dataparallel-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">torch.neuron.DataParallel API</p> </div> </a> <a class="right-next" id="next-link" href="developer-guide-torch-neuron.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:58.367Z
Developer Guide (torch-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/developer-guide-torch-neuron.html
# Developer Guide (torch-neuron) — AWS Neuron Documentation previous PyTorch Neuron (`torch-neuron`) Core Placement API \[Experimental\]
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Developer Guide (torch-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Running inference on variable input shapes with bucketing" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> <link rel="prev" title="PyTorch Neuron (torch-neuron) Core Placement API [Experimental]" href="api-core-placement.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/developer-guide-torch-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/developer-guide-torch-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/developer-guide-torch-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuron/developer-guide-torch-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Developer Guide (torch-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="developer-guide-torch-neuron"> <h1>Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<a class="headerlink" href="#developer-guide-torch-neuron" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html#bucketing-app-note"><span class="std std-ref">Running Inference on Variable Input Shapes with Bucketing</span></a></p></li> <li><p><a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html#torch-neuron-dataparallel-app-note"><span class="std std-ref">Data Parallel Inference on PyTorch Neuron</span></a></p></li> <li><p><a class="reference internal" href="guides/torch-lstm-support.html#torch-neuron-lstm-support"><span class="std std-ref">Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support</span></a></p></li> <li><p><a class="reference internal" href="guides/core-placement/torch-core-placement.html#torch-neuron-core-placement-guide"><span class="std std-ref">PyTorch Neuron (torch-neuron) Core Placement</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-core-placement.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Core Placement API [Experimental]</p> </div> </a> <a class="right-next" id="next-link" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Running inference on variable input shapes with bucketing</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:58.963Z
Data Parallel Inference on Torch Neuron — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html
# Data Parallel Inference on Torch Neuron — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## Data Parallel Inference on Torch Neuron[#](#data-parallel-inference-on-torch-neuron "Permalink to this headline") Table of Contents - [Introduction](#introduction) - [Data parallel inference](#data-parallel-inference) - [torch.neuron.DataParallel](#torch-neuron-dataparallel) - [NeuronCore selection](#neuroncore-selection) - [Batch dim](#batch-dim) - [Dynamic batching](#dynamic-batching) - [Performance optimizations](#performance-optimizations) - [Examples](#examples) - [Default usage](#default-usage) - [Specifying NeuronCores](#specifying-neuroncores) - [DataParallel with dim != 0](#dataparallel-with-dim-0) - [Dynamic batching](#dataparallel-example-dynamic-batching) - [Dynamic batching disabled](#dynamic-batching-disabled) - [Full tutorial with torch.neuron.DataParallel](#full-tutorial-with-torch-neuron-dataparallel) ## [Introduction](#id2)[#](#introduction "Permalink to this headline") This guide introduces [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel"), a Python API that implements data parallelism on [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") models created by the /neuron-guide/neuron-frameworks/pytorch-neuron/api-compilation-python-api.rst. The following sections explain how data parallelism can improve the performance of inference workloads on Inferentia, including how [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") uses dynamic batching to run inference on variable input sizes. It covers an overview of the [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") module and provides a few [example data parallel applications](#data-paraellel-examples). ## [Data parallel inference](#id3)[#](#data-parallel-inference "Permalink to this headline") Data Parallelism is a form of parallelization across multiple devices or cores, referred to as nodes. Each node contains the same model and parameters, but data is distributed across the different nodes. By distributing the data across multiple nodes, data parallelism reduces the total execution time of large batch size inputs compared to sequential execution. Data parallelism works best for smaller models in latency sensitive applications that have large batch size requirements. ## [torch.neuron.DataParallel](#id4)[#](#torch-neuron-dataparallel "Permalink to this headline") To fully leverage the Inferentia hardware, we want to use all available NeuronCores. An inf1.xlarge and inf1.2xlarge have four NeuronCores, an inf1.6xlarge has 16 NeuronCores, and an inf1.24xlarge has 64 NeuronCores. For maximum performance on Inferentia hardware, we can use [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") to utilize all available NeuronCores. [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") implements data parallelism at the module level by replicating the Neuron model on all available NeuronCores and distributing data across the different cores for parallelized inference. This function is analogous to [`DataParallel`](https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") in PyTorch. [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") requires PyTorch >= 1.8. The following sections provide an overview of some of the features of [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") that enable maximum performance on Inferentia. ### [NeuronCore selection](#id5)[#](#neuroncore-selection "Permalink to this headline") By default, DataParallel will try to use all NeuronCores allocated to the current process to fully saturate the Inferentia hardware for maximum performance. It is more efficient to make the batch dimension divisible by the number of NeuronCores. This will ensure that NeuronCores are not left idle during parallel inference and the Inferentia hardware is fully utilized. In some applications, it is advantageous to use a subset of the available NeuronCores for DataParallel inference. DataParallel has a `device_ids` argument that accepts a list of [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)") or `'nc:#'` that specify the NeuronCores to use for parallelization. See [Specifying NeuronCores](#dataparallel-example-specify-ncs) for an example of how to use `device_ids` argument. ### [Batch dim](#id6)[#](#batch-dim "Permalink to this headline") DataParallel accepts a `dim` argument that denotes the batch dimension used to split the input data for distributed inference. By default, DataParalell splits the inputs on `dim = 0` if the `dim` argument is not specified. For applications with a non-zero batch dim, the `dim` argument can be used to specify the inference-time input batch dimension. [DataParallel with dim ! = 0](#data-paraellel-examples) provides an example of data parallel inference on inputs with batch dim = 2. ### [Dynamic batching](#id7)[#](#dynamic-batching "Permalink to this headline") Batch size has a direct impact on model performance. The Inferentia chip is optimized to run with small batch sizes. This means that a Neuron compiled model can outperform a GPU model, even if running single digit batch sizes. As a general best practice, we recommend optimizing your model’s throughput by compiling the model with a small batch size and gradually increasing it to find the peak throughput on Inferentia. Dynamic batching is a feature that allows you to use tensor batch sizes that the Neuron model was not originally compiled against. This is necessary because the underlying Inferentia hardware will always execute inferences with the batch size used during compilation. Fixed batch size execution allows tuning the input batch size for optimal performance. For example, batch size 1 may be best suited for an ultra-low latency on-demand inference application, while batch size > 1 can be used to maximize throughput for offline inferencing. Dynamic batching is implemented by slicing large input tensors into chunks that match the batch size used during the [`torch_neuron.trace()`](../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace "torch_neuron.trace") compilation call. The [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") class automatically enables dynamic batching on eligible models. This allows us to run inference in applications that have inputs with a variable batch size without needing to recompile the model. See [Dynamic batching](#dataparallel-example-dynamic-batching) for an example of how DataParallel can be used to run inference on inputs with a dynamic batch size without needing to recompile the model. Dynamic batching using small batch sizes can result in sub-optimal throughput because it involves slicing tensors into chunks and iteratively sending data to the hardware. Using a larger batch size at compilation time can use the Inferentia hardware more efficiently in order to maximize throughput. You can test the tradeoff between individual request latency and total throughput by fine-tuning the input batch size. Automatic batching in the DataParallel module can be disabled using the `disable_dynamic_batching()` function as follows: ``` >>> model_parallel = torch.neuron.DataParallel(model_neuron) >>> model_parallel.disable_dynamic_batching() ``` If dynamic batching is disabled, the compile-time batch size must be equal to the inference-time batch size divided by the number of NeuronCores. [DataParallel with dim != 0](#dataparallel-example-dim-neq-zero) and [Dynamic batching disabled](#dataparallel-example-disable-dynamic-batching) provide examples of running DataParallel inference with dynamic batching disabled. ### [Performance optimizations](#id8)[#](#performance-optimizations "Permalink to this headline") The DataParallel module has a `num_workers` attribute that can be used to specify the number of worker threads used for multithreaded inference. By default, `num_workers = 2 * number of NeuronCores`. This value can be fine tuned to optimize DataParallel performance. DataParallel has a `split_size` attribute that dictates the size of the input chunks that are distributed to each NeuronCore. By default, `split_size = max(1, input.shape[dim] // number of NeuronCores)`. This value can be modified to optimally match the inference input chunk size with the compile-time batch size. ## [Examples](#id9)[#](#examples "Permalink to this headline") The following sections provide example usages of the [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") module. ### [Default usage](#id10)[#](#default-usage "Permalink to this headline") The default DataParallel use mode will replicate the model on all available NeuronCores in the current process. The inputs will be split on `dim=0`. ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module model_parallel = torch.neuron.DataParallel(model_neuron) # Create a batched input batch_size = 5 image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### [Specifying NeuronCores](#id11)[#](#specifying-neuroncores "Permalink to this headline") The following example uses the `device_ids` argument to use the first three NeuronCores for DataParallel inference. ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module, run on the first three NeuronCores # Equivalent to model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1, 2]) model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=['nc:0', 'nc:1', 'nc:2']) # Create a batched input batch_size = 5 image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### [DataParallel with dim != 0](#id12)[#](#dataparallel-with-dim-0 "Permalink to this headline") In this example we run DataParallel inference using four NeuronCores and `dim = 2`. Because `dim != 0`, dynamic batching is not enabled. Consequently, the DataParallel inference-time batch size must be four times the compile-time batch size. DataParallel will generate a warning that dynamic batching is disabled because `dim != 0`. ``` import torch import torch_neuron # Create an example model class Model(torch.nn.Module): def __init__(self): super().__init__() self.conv = torch.nn.Conv2d(3, 3, 3) def forward(self, x): return self.conv(x) + 1 model = Model() model.eval() # Compile with an example input image = torch.rand([1, 3, 8, 8]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module using 4 NeuronCores and dim = 2 model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1, 2, 3], dim=2) # Create a batched input # Note that image_batched.shape[dim] / len(device_ids) == image.shape[dim] batch_size = 4 * 8 image_batched = torch.rand([1, 3, batch_size, 8]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### [Dynamic batching](#id13)[#](#dataparallel-example-dynamic-batching "Permalink to this headline") In the following example, we use the [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") module to run inference using several different batch sizes without recompiling the Neuron model. ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module model_parallel = torch.neuron.DataParallel(model_neuron) # Create batched inputs and run inference on the same model batch_sizes = [2, 3, 4, 5, 6] for batch_size in batch_sizes: image_batched = torch.rand([batch_size, 3, 224, 224]) # Run inference with a batched input output = model_parallel(image_batched) ``` ### [Dynamic batching disabled](#id14)[#](#dynamic-batching-disabled "Permalink to this headline") In the following example, we use [`torch.neuron.DataParallel.disable_dynamic_batching()`](../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch.neuron.DataParallel.disable_dynamic_batching "torch.neuron.DataParallel.disable_dynamic_batching") to disable dynamic batching. We provide an example of a batch size that will not work when dynamic batching is disabled as well as an example of a batch size that does work when dynamic batching is disabled. ``` import torch import torch_neuron from torchvision import models # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Compile with an example input image = torch.rand([1, 3, 224, 224]) model_neuron = torch.neuron.trace(model, image) # Create the DataParallel module and use 4 NeuronCores model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1, 2, 3], dim=0) # Disable dynamic batching model_parallel.disable_dynamic_batching() # Create a batched input (this won't work) batch_size = 8 image_batched = torch.rand([batch_size, 3, 224, 224]) # This will fail because dynamic batching is disabled and # image_batched.shape[dim] / len(device_ids) != image.shape[dim] # output = model_parallel(image_batched) # Create a batched input (this will work) batch_size = 4 image_batched = torch.rand([batch_size, 3, 224, 224]) # This will work because # image_batched.shape[dim] / len(device_ids) == image.shape[dim] output = model_parallel(image_batched) ```
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Data Parallel Inference on Torch Neuron — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> <link rel="prev" title="Running inference on variable input shapes with bucketing" href="bucketing-app-note.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fgeneral/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#data-parallel-inference"> Data parallel inference </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-neuron-dataparallel"> torch.neuron.DataParallel </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-selection"> NeuronCore selection </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#batch-dim"> Batch dim </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#performance-optimizations"> Performance optimizations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-usage"> Default usage </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#specifying-neuroncores"> Specifying NeuronCores </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-with-dim-0"> DataParallel with dim != 0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-example-dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching-disabled"> Dynamic batching disabled </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#full-tutorial-with-torch-neuron-dataparallel"> Full tutorial with torch.neuron.DataParallel </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Data Parallel Inference on Torch Neuron</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#data-parallel-inference"> Data parallel inference </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-neuron-dataparallel"> torch.neuron.DataParallel </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-selection"> NeuronCore selection </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#batch-dim"> Batch dim </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#performance-optimizations"> Performance optimizations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-usage"> Default usage </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#specifying-neuroncores"> Specifying NeuronCores </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-with-dim-0"> DataParallel with dim != 0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataparallel-example-dynamic-batching"> Dynamic batching </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching-disabled"> Dynamic batching disabled </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#full-tutorial-with-torch-neuron-dataparallel"> Full tutorial with torch.neuron.DataParallel </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="data-parallel-inference-on-torch-neuron"> <span id="torch-neuron-dataparallel-app-note"></span><h1>Data Parallel Inference on Torch Neuron<a class="headerlink" href="#data-parallel-inference-on-torch-neuron" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#introduction" id="id2">Introduction</a></p></li> <li><p><a class="reference internal" href="#data-parallel-inference" id="id3">Data parallel inference</a></p></li> <li><p><a class="reference internal" href="#torch-neuron-dataparallel" id="id4">torch.neuron.DataParallel</a></p> <ul> <li><p><a class="reference internal" href="#neuroncore-selection" id="id5">NeuronCore selection</a></p></li> <li><p><a class="reference internal" href="#batch-dim" id="id6">Batch dim</a></p></li> <li><p><a class="reference internal" href="#dynamic-batching" id="id7">Dynamic batching</a></p></li> <li><p><a class="reference internal" href="#performance-optimizations" id="id8">Performance optimizations</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#examples" id="id9">Examples</a></p> <ul> <li><p><a class="reference internal" href="#default-usage" id="id10">Default usage</a></p></li> <li><p><a class="reference internal" href="#specifying-neuroncores" id="id11">Specifying NeuronCores</a></p></li> <li><p><a class="reference internal" href="#dataparallel-with-dim-0" id="id12">DataParallel with dim != 0</a></p></li> <li><p><a class="reference internal" href="#dataparallel-example-dynamic-batching" id="id13">Dynamic batching</a></p></li> <li><p><a class="reference internal" href="#dynamic-batching-disabled" id="id14">Dynamic batching disabled</a></p></li> <li><p><a class="reference internal" href="#full-tutorial-with-torch-neuron-dataparallel" id="id15">Full tutorial with torch.neuron.DataParallel</a></p></li> </ul> </li> </ul> </div> <div class="section" id="introduction"> <h2><a class="toc-backref" href="#id2">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">#</a></h2> <p>This guide introduces <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a>, a Python API that implements data parallelism on <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> models created by the <span class="xref std std-ref">/neuron-guide/neuron-frameworks/pytorch-neuron/api-compilation-python-api.rst</span>. The following sections explain how data parallelism can improve the performance of inference workloads on Inferentia, including how <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> uses dynamic batching to run inference on variable input sizes. It covers an overview of the <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> module and provides a few <a class="reference internal" href="#data-paraellel-examples"><span class="std std-ref">example data parallel applications</span></a>.</p> </div> <div class="section" id="data-parallel-inference"> <h2><a class="toc-backref" href="#id3">Data parallel inference</a><a class="headerlink" href="#data-parallel-inference" title="Permalink to this headline">#</a></h2> <p>Data Parallelism is a form of parallelization across multiple devices or cores, referred to as nodes. Each node contains the same model and parameters, but data is distributed across the different nodes. By distributing the data across multiple nodes, data parallelism reduces the total execution time of large batch size inputs compared to sequential execution. Data parallelism works best for smaller models in latency sensitive applications that have large batch size requirements.</p> </div> <div class="section" id="torch-neuron-dataparallel"> <h2><a class="toc-backref" href="#id4">torch.neuron.DataParallel</a><a class="headerlink" href="#torch-neuron-dataparallel" title="Permalink to this headline">#</a></h2> <p>To fully leverage the Inferentia hardware, we want to use all available NeuronCores. An inf1.xlarge and inf1.2xlarge have four NeuronCores, an inf1.6xlarge has 16 NeuronCores, and an inf1.24xlarge has 64 NeuronCores. For maximum performance on Inferentia hardware, we can use <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> to utilize all available NeuronCores.</p> <p><a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> implements data parallelism at the module level by replicating the Neuron model on all available NeuronCores and distributing data across the different cores for parallelized inference. This function is analogous to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.DataParallel.html#torch.nn.DataParallel" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataParallel</span></code></a> in PyTorch. <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> requires PyTorch &gt;= 1.8.</p> <p>The following sections provide an overview of some of the features of <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> that enable maximum performance on Inferentia.</p> <div class="section" id="neuroncore-selection"> <h3><a class="toc-backref" href="#id5">NeuronCore selection</a><a class="headerlink" href="#neuroncore-selection" title="Permalink to this headline">#</a></h3> <p>By default, DataParallel will try to use all NeuronCores allocated to the current process to fully saturate the Inferentia hardware for maximum performance. It is more efficient to make the batch dimension divisible by the number of NeuronCores. This will ensure that NeuronCores are not left idle during parallel inference and the Inferentia hardware is fully utilized.</p> <p>In some applications, it is advantageous to use a subset of the available NeuronCores for DataParallel inference. DataParallel has a <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument that accepts a list of <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> or <code class="docutils literal notranslate"><span class="pre">'nc:#'</span></code> that specify the NeuronCores to use for parallelization. See <a class="reference internal" href="#dataparallel-example-specify-ncs"><span class="std std-ref">Specifying NeuronCores</span></a> for an example of how to use <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument.</p> </div> <div class="section" id="batch-dim"> <h3><a class="toc-backref" href="#id6">Batch dim</a><a class="headerlink" href="#batch-dim" title="Permalink to this headline">#</a></h3> <p>DataParallel accepts a <code class="docutils literal notranslate"><span class="pre">dim</span></code> argument that denotes the batch dimension used to split the input data for distributed inference. By default, DataParalell splits the inputs on <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">=</span> <span class="pre">0</span></code> if the <code class="docutils literal notranslate"><span class="pre">dim</span></code> argument is not specified. For applications with a non-zero batch dim, the <code class="docutils literal notranslate"><span class="pre">dim</span></code> argument can be used to specify the inference-time input batch dimension. <a class="reference internal" href="#data-paraellel-examples"><span class="std std-ref">DataParallel with dim ! = 0</span></a> provides an example of data parallel inference on inputs with batch dim = 2.</p> </div> <div class="section" id="dynamic-batching"> <span id="dynamic-batching-description"></span><h3><a class="toc-backref" href="#id7">Dynamic batching</a><a class="headerlink" href="#dynamic-batching" title="Permalink to this headline">#</a></h3> <p>Batch size has a direct impact on model performance. The Inferentia chip is optimized to run with small batch sizes. This means that a Neuron compiled model can outperform a GPU model, even if running single digit batch sizes.</p> <p>As a general best practice, we recommend optimizing your model’s throughput by compiling the model with a small batch size and gradually increasing it to find the peak throughput on Inferentia.</p> <p>Dynamic batching is a feature that allows you to use tensor batch sizes that the Neuron model was not originally compiled against. This is necessary because the underlying Inferentia hardware will always execute inferences with the batch size used during compilation. Fixed batch size execution allows tuning the input batch size for optimal performance. For example, batch size 1 may be best suited for an ultra-low latency on-demand inference application, while batch size &gt; 1 can be used to maximize throughput for offline inferencing. Dynamic batching is implemented by slicing large input tensors into chunks that match the batch size used during the <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> compilation call.</p> <p>The <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> class automatically enables dynamic batching on eligible models. This allows us to run inference in applications that have inputs with a variable batch size without needing to recompile the model. See <a class="reference internal" href="#dataparallel-example-dynamic-batching"><span class="std std-ref">Dynamic batching</span></a> for an example of how DataParallel can be used to run inference on inputs with a dynamic batch size without needing to recompile the model.</p> <p>Dynamic batching using small batch sizes can result in sub-optimal throughput because it involves slicing tensors into chunks and iteratively sending data to the hardware. Using a larger batch size at compilation time can use the Inferentia hardware more efficiently in order to maximize throughput. You can test the tradeoff between individual request latency and total throughput by fine-tuning the input batch size.</p> <p>Automatic batching in the DataParallel module can be disabled using the <code class="docutils literal notranslate"><span class="pre">disable_dynamic_batching()</span></code> function as follows:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="gp">&gt;&gt;&gt; </span><span class="n">model_parallel</span><span class="o">.</span><span class="n">disable_dynamic_batching</span><span class="p">()</span> </pre></div> </div> <p>If dynamic batching is disabled, the compile-time batch size must be equal to the inference-time batch size divided by the number of NeuronCores. <a class="reference internal" href="#dataparallel-example-dim-neq-zero"><span class="std std-ref">DataParallel with dim != 0</span></a> and <a class="reference internal" href="#dataparallel-example-disable-dynamic-batching"><span class="std std-ref">Dynamic batching disabled</span></a> provide examples of running DataParallel inference with dynamic batching disabled.</p> </div> <div class="section" id="performance-optimizations"> <h3><a class="toc-backref" href="#id8">Performance optimizations</a><a class="headerlink" href="#performance-optimizations" title="Permalink to this headline">#</a></h3> <p>The DataParallel module has a <code class="docutils literal notranslate"><span class="pre">num_workers</span></code> attribute that can be used to specify the number of worker threads used for multithreaded inference. By default, <code class="docutils literal notranslate"><span class="pre">num_workers</span> <span class="pre">=</span> <span class="pre">2</span> <span class="pre">*</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">NeuronCores</span></code>. This value can be fine tuned to optimize DataParallel performance.</p> <p>DataParallel has a <code class="docutils literal notranslate"><span class="pre">split_size</span></code> attribute that dictates the size of the input chunks that are distributed to each NeuronCore. By default, <code class="docutils literal notranslate"><span class="pre">split_size</span> <span class="pre">=</span> <span class="pre">max(1,</span> <span class="pre">input.shape[dim]</span> <span class="pre">//</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">NeuronCores)</span></code>. This value can be modified to optimally match the inference input chunk size with the compile-time batch size.</p> </div> </div> <div class="section" id="examples"> <span id="data-paraellel-examples"></span><h2><a class="toc-backref" href="#id9">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline">#</a></h2> <p>The following sections provide example usages of the <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> module.</p> <div class="section" id="default-usage"> <span id="dataparallel-example-default"></span><h3><a class="toc-backref" href="#id10">Default usage</a><a class="headerlink" href="#default-usage" title="Permalink to this headline">#</a></h3> <p>The default DataParallel use mode will replicate the model on all available NeuronCores in the current process. The inputs will be split on <code class="docutils literal notranslate"><span class="pre">dim=0</span></code>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="c1"># Create a batched input</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">5</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="specifying-neuroncores"> <span id="dataparallel-example-specify-ncs"></span><h3><a class="toc-backref" href="#id11">Specifying NeuronCores</a><a class="headerlink" href="#specifying-neuroncores" title="Permalink to this headline">#</a></h3> <p>The following example uses the <code class="docutils literal notranslate"><span class="pre">device_ids</span></code> argument to use the first three NeuronCores for DataParallel inference.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module, run on the first three NeuronCores</span> <span class="c1"># Equivalent to model_parallel = torch.neuron.DataParallel(model_neuron, device_ids=[0, 1, 2])</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="s1">'nc:0'</span><span class="p">,</span> <span class="s1">'nc:1'</span><span class="p">,</span> <span class="s1">'nc:2'</span><span class="p">])</span> <span class="c1"># Create a batched input</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">5</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dataparallel-with-dim-0"> <span id="dataparallel-example-dim-neq-zero"></span><h3><a class="toc-backref" href="#id12">DataParallel with dim != 0</a><a class="headerlink" href="#dataparallel-with-dim-0" title="Permalink to this headline">#</a></h3> <p>In this example we run DataParallel inference using four NeuronCores and <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">=</span> <span class="pre">2</span></code>. Because <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">!=</span> <span class="pre">0</span></code>, dynamic batching is not enabled. Consequently, the DataParallel inference-time batch size must be four times the compile-time batch size. DataParallel will generate a warning that dynamic batching is disabled because <code class="docutils literal notranslate"><span class="pre">dim</span> <span class="pre">!=</span> <span class="pre">0</span></code>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="c1"># Create an example model</span> <span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Model</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">8</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module using 4 NeuronCores and dim = 2</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="c1"># Create a batched input</span> <span class="c1"># Note that image_batched.shape[dim] / len(device_ids) == image.shape[dim]</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">4</span> <span class="o">*</span> <span class="mi">8</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="mi">8</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dataparallel-example-dynamic-batching"> <span id="id1"></span><h3><a class="toc-backref" href="#id13">Dynamic batching</a><a class="headerlink" href="#dataparallel-example-dynamic-batching" title="Permalink to this headline">#</a></h3> <p>In the following example, we use the <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> module to run inference using several different batch sizes without recompiling the Neuron model.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">)</span> <span class="c1"># Create batched inputs and run inference on the same model</span> <span class="n">batch_sizes</span> <span class="o">=</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]</span> <span class="k">for</span> <span class="n">batch_size</span> <span class="ow">in</span> <span class="n">batch_sizes</span><span class="p">:</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># Run inference with a batched input</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="dynamic-batching-disabled"> <span id="dataparallel-example-disable-dynamic-batching"></span><h3><a class="toc-backref" href="#id14">Dynamic batching disabled</a><a class="headerlink" href="#dynamic-batching-disabled" title="Permalink to this headline">#</a></h3> <p>In the following example, we use <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html#torch.neuron.DataParallel.disable_dynamic_batching" title="torch.neuron.DataParallel.disable_dynamic_batching"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel.disable_dynamic_batching()</span></code></a> to disable dynamic batching. We provide an example of a batch size that will not work when dynamic batching is disabled as well as an example of a batch size that does work when dynamic batching is disabled.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile with an example input</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Create the DataParallel module and use 4 NeuronCores</span> <span class="n">model_parallel</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">DataParallel</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">device_ids</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># Disable dynamic batching</span> <span class="n">model_parallel</span><span class="o">.</span><span class="n">disable_dynamic_batching</span><span class="p">()</span> <span class="c1"># Create a batched input (this won't work)</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">8</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># This will fail because dynamic batching is disabled and</span> <span class="c1"># image_batched.shape[dim] / len(device_ids) != image.shape[dim]</span> <span class="c1"># output = model_parallel(image_batched)</span> <span class="c1"># Create a batched input (this will work)</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">image_batched</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="n">batch_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">])</span> <span class="c1"># This will work because</span> <span class="c1"># image_batched.shape[dim] / len(device_ids) == image.shape[dim]</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model_parallel</span><span class="p">(</span><span class="n">image_batched</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="full-tutorial-with-torch-neuron-dataparallel"> <h3><a class="toc-backref" href="#id15">Full tutorial with torch.neuron.DataParallel</a><a class="headerlink" href="#full-tutorial-with-torch-neuron-dataparallel" title="Permalink to this headline">#</a></h3> <p>For an end-to-end tutorial that uses DataParallel, see the <a class="reference internal" href="../../../src/examples/pytorch/resnet50.html"><span class="std std-ref">PyTorch Resnet Tutorial</span></a>.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="bucketing-app-note.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Running inference on variable input shapes with bucketing</p> </div> </a> <a class="right-next" id="next-link" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Developer Guide - PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) <code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code> Support</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:59.172Z
Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/guides/torch-lstm-support.html
# Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## Developer Guide - PyTorch Neuron (`torch-neuron`) [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") Support[#](#developer-guide-pytorch-neuron-torch-neuron-lstm-support "Permalink to this headline") The torch-neuron package can support [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") operations and yield high performance on both fixed-length and variable-length sequences. Most network configurations can be supported, with the exception of those that require [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") usage outside of [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") or [`pad_packed_sequence()`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") operations. Neuron must guarantee that the shapes can remain fixed throughout the network. The following sections describe which scenarios can and cannot be supported. ## Supported Usage[#](#supported-usage "Permalink to this headline") ### Fixed-Length Sequences[#](#fixed-length-sequences "Permalink to this headline") In normal usage of an [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"), the inputs and outputs are expected to be a fixed size sequence length. This is the most basic usage of an [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") but may not be applicable to applications where the input sequence length may vary. ``` import torch import torch_neuron class Network(torch.nn.Module): def __init__(self): super().__init__() self.lstm = torch.nn.LSTM(input_size=3, hidden_size=7) def forward(self, inputs): output, (ht, ct) = self.lstm(inputs) return output, (ht, ct) # Example Inputs seq_len, batch_size, input_size = 5, 2, 3 inputs = torch.rand(seq_len, batch_size, input_size) # Trace torch_neuron.trace(Network(), (inputs,)) ``` ### Packed Input, Padded Output, _Pre-Sorted_ Inputs[#](#packed-input-padded-output-pre-sorted-inputs "Permalink to this headline") A common usage of an [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") is when the input sequence sizes vary according to an input sequence lengths (such as tokens). For example, the following sentences could result in two different sequence lengths after tokenization: ``` # Input text = [ 'Hello, sailor', 'Example', ] # ... Tokenization ... # Result tokens = [ [101, 7592, 1010, 11803, 102], [101, 2742, 102, 0, 0], ] lengths = [5, 3] ``` Because the lengths are different, the final [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") state will be dependent upon the lengths of each sequence in the batch. Torch provides a way to deal with these types of sequences by densely packing batches into a [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). The most common way this is constructed is by using the [`pack_padded_sequence()`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pack_padded_sequence.html#torch.nn.utils.rnn.pack_padded_sequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") utility function prior to feeding inputs into the [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). Packing the above sequences would result in the following data and batch size tensors. ``` data = [101, 101, 7592, 2742, 1010, 102, 11803, 102] batch_sizes = [2, 2, 2, 1, 1] ``` In addition to correctly computing final [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") state, using a packed sequence instead of a padded sequence also improves model performance on CPU. On Neuron, where computation is fixed to the maximum length ahead of time, **this is does not improve performance**. When an [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") is processing a [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"), it must do so in a descending sorted length order. To ensure that sequences are sorted, [`pack_padded_sequence()`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pack_padded_sequence.html#torch.nn.utils.rnn.pack_padded_sequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") provides an `enforce_sorted` flag. When `enforce_sorted` is `True`, the input is _already expected_ to contain sequences sorted by length in a decreasing order along the batch dimension. Note that this must be enforced in the application-level code but is only relevant when batch size > 1. The following network can compile successfully because the input and output to the network are guaranteed to be a fixed shape. The input shape is expected to be a padded tensor and the output tensor is expected to be padded to the maximum sequence length using the [`pad_packed_sequence()`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function call: ``` import torch import torch_neuron class Network(torch.nn.Module): def __init__(self): super().__init__() self.lstm = torch.nn.LSTM(input_size=3, hidden_size=7) def forward(self, inputs, lengths): packed_input = torch.nn.utils.rnn.pack_padded_sequence( inputs, lengths=lengths, enforce_sorted=True, ) packed_result, (ht, ct) = self.lstm(packed_input) padded_result, _ = torch.nn.utils.rnn.pad_packed_sequence(packed_result) return padded_result, ht, ct # Example Inputs seq_len, batch_size, input_size = 5, 2, 3 inputs = torch.rand(seq_len, batch_size, input_size) lengths = torch.tensor([seq_len] * batch_size) # Trace torch_neuron.trace(Network(), (inputs, lengths)) ``` ### Packed Input, Padded Output, _Unsorted_ Inputs[#](#packed-input-padded-output-unsorted-inputs "Permalink to this headline") When `enforce_sorted` is `False`, the input will be sorted unconditionally. This causes some CPU overhead on Neuron because unsupported operators will be inserted into the graph such as `aten::sort` and `aten::scatter_`. The `aten::lstm` operation can still be supported, but it will be less efficient than when `enforce_sorted` is `True`. The following code is able to be traced, but results in the sorting operations running on CPU. This is not problematic in this case because the `aten::sort` and `aten::scatter_` are executed on CPU at the very beginning of the graph just prior to Neuron execution. Like the previous example, the call to [`pad_packed_sequence()`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") ensures that the output is a fixed-shape based on the maximum sequence length. ``` import torch import torch_neuron class Network(torch.nn.Module): def __init__(self): super().__init__() self.lstm = torch.nn.LSTM(input_size=3, hidden_size=7) def forward(self, inputs, lengths): packed_input = torch.nn.utils.rnn.pack_padded_sequence( inputs, lengths=lengths, enforce_sorted=False, ) packed_result, (ht, ct) = self.lstm(packed_input) padded_result, _ = torch.nn.utils.rnn.pad_packed_sequence(packed_result) return padded_result, ht, ct # Example Inputs seq_len, batch_size, input_size = 5, 2, 3 inputs = torch.rand(seq_len, batch_size, input_size) lengths = torch.tensor([seq_len] * batch_size) # Trace trace = torch_neuron.trace(Network(), (inputs, lengths)) ``` ## Unsupported Usage[#](#unsupported-usage "Permalink to this headline") Neuron does not support the use of a [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") outside of the [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") operation and the [`pad_packed_sequence()`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") operation. This is because the shape of a [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") can vary depending on the input data. This is incompatible with the Neuron restriction that all tensor sizes must be known at compilation time. When a [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") is used only by an [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") or [`pad_packed_sequence()`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") operation, Neuron _can guarantee_ the size of the intermediary tensors by padding on behalf of the application. This means that If the [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") is either used by a different operation or returned from the network this would result in all of the [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") operations to be executed on CPU or the network compilation will fail. ### [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") Returned[#](#packedsequence-returned "Permalink to this headline") The following is unsupported because the [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") result of the [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") is returned by the network: ``` class Network(torch.nn.Module): def __init__(self): super().__init__() self.lstm = torch.nn.LSTM(input_size=3, hidden_size=7) def forward(self, inputs, lengths): packed_input = torch.nn.utils.rnn.pack_padded_sequence( inputs, lengths=lengths, enforce_sorted=False, ) packed_result, (ht, ct) = self.lstm(packed_input) return packed_result.data, ht, ct ``` **Behavior**: In this case, compilation fails and the following warning is generated: ``` Operator "aten::lstm" consuming a PackedSequence input can only be supported when its corresponding PackedSequence output is unused or unpacked using "aten::_pad_packed_input". Found usage by "prim::Return" ``` **Resolution**: To avoid this error, the `packed_result` should be padded prior to being returned from the network by using [`pad_packed_sequence()`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") ### Invalid [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") Usage[#](#invalid-packedsequence-usage "Permalink to this headline") The following is unsupported because the [`PackedSequence`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") result of the [`LSTM`](https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") is used by a non-LSTM operator: ``` class Network(torch.nn.Module): def __init__(self): super().__init__() self.lstm = torch.nn.LSTM(input_size=3, hidden_size=7) def forward(self, inputs, lengths): packed_input = torch.nn.utils.rnn.pack_padded_sequence( inputs, lengths=lengths, enforce_sorted=False, ) packed_result, (ht, ct) = self.lstm(packed_input) return torch.max(packed_result.data) ``` **Behavior**: In this case, compilation fails and the following warning is generated: ``` Operator "aten::lstm" consuming a PackedSequence input can only be supported when its corresponding PackedSequence output is unused or unpacked using "aten::_pad_packed_input". Found usage by "aten::max" ``` **Resolution**: To avoid this error, the `packed_result` should be padded prior to being used in the [`max()`](https://pytorch.org/docs/master/generated/torch.max.html#torch.max "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") from the network by using [`pad_packed_sequence()`](https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuron) Core Placement" href="core-placement/torch-core-placement.html"> <link rel="prev" title="Data Parallel Inference on Torch Neuron" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/guides/torch-lstm-support", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../developer-guide-torch-neuron.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/guides/torch-lstm-support.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/guides/torch-lstm-support.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/torch/torch-neuron/guides/torch-lstm-support.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#supported-usage"> Supported Usage </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#fixed-length-sequences"> Fixed-Length Sequences </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#packed-input-padded-output-pre-sorted-inputs"> Packed Input, Padded Output, <em> Pre-Sorted </em> Inputs </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#packed-input-padded-output-unsorted-inputs"> Packed Input, Padded Output, <em> Unsorted </em> Inputs </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#packed-inputs-final-hidden-cell-state-only"> Packed Inputs, Final Hidden &amp; Cell State Only </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#unsupported-usage"> Unsupported Usage </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#packedsequence-returned"> <code class="xref py py-class docutils literal notranslate"> <span class="pre"> PackedSequence </span> </code> Returned </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#invalid-packedsequence-usage"> Invalid <code class="xref py py-class docutils literal notranslate"> <span class="pre"> PackedSequence </span> </code> Usage </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#supported-usage"> Supported Usage </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#fixed-length-sequences"> Fixed-Length Sequences </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#packed-input-padded-output-pre-sorted-inputs"> Packed Input, Padded Output, <em> Pre-Sorted </em> Inputs </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#packed-input-padded-output-unsorted-inputs"> Packed Input, Padded Output, <em> Unsorted </em> Inputs </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#packed-inputs-final-hidden-cell-state-only"> Packed Inputs, Final Hidden &amp; Cell State Only </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#unsupported-usage"> Unsupported Usage </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#packedsequence-returned"> <code class="xref py py-class docutils literal notranslate"> <span class="pre"> PackedSequence </span> </code> Returned </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#invalid-packedsequence-usage"> Invalid <code class="xref py py-class docutils literal notranslate"> <span class="pre"> PackedSequence </span> </code> Usage </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="developer-guide-pytorch-neuron-torch-neuron-lstm-support"> <span id="torch-neuron-lstm-support"></span><h1>Developer Guide - PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> Support<a class="headerlink" href="#developer-guide-pytorch-neuron-torch-neuron-lstm-support" title="Permalink to this headline">#</a></h1> <p>The <cite>torch-neuron</cite> package can support <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> operations and yield high performance on both fixed-length and variable-length sequences. Most network configurations can be supported, with the exception of those that require <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a> usage outside of <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> or <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pad_packed_sequence()</span></code></a> operations. Neuron must guarantee that the shapes can remain fixed throughout the network.</p> <p>The following sections describe which scenarios can and cannot be supported.</p> <div class="section" id="supported-usage"> <h2>Supported Usage<a class="headerlink" href="#supported-usage" title="Permalink to this headline">#</a></h2> <div class="section" id="fixed-length-sequences"> <h3>Fixed-Length Sequences<a class="headerlink" href="#fixed-length-sequences" title="Permalink to this headline">#</a></h3> <p>In normal usage of an <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a>, the inputs and outputs are expected to be a fixed size sequence length. This is the most basic usage of an <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> but may not be applicable to applications where the input sequence length may vary.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="k">class</span> <span class="nc">Network</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">LSTM</span><span class="p">(</span><span class="n">input_size</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">hidden_size</span><span class="o">=</span><span class="mi">7</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inputs</span><span class="p">):</span> <span class="n">output</span><span class="p">,</span> <span class="p">(</span><span class="n">ht</span><span class="p">,</span> <span class="n">ct</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span><span class="p">(</span><span class="n">inputs</span><span class="p">)</span> <span class="k">return</span> <span class="n">output</span><span class="p">,</span> <span class="p">(</span><span class="n">ht</span><span class="p">,</span> <span class="n">ct</span><span class="p">)</span> <span class="c1"># Example Inputs</span> <span class="n">seq_len</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">input_size</span> <span class="o">=</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="n">seq_len</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">input_size</span><span class="p">)</span> <span class="c1"># Trace</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">Network</span><span class="p">(),</span> <span class="p">(</span><span class="n">inputs</span><span class="p">,))</span> </pre></div> </div> </div> <div class="section" id="packed-input-padded-output-pre-sorted-inputs"> <h3>Packed Input, Padded Output, <em>Pre-Sorted</em> Inputs<a class="headerlink" href="#packed-input-padded-output-pre-sorted-inputs" title="Permalink to this headline">#</a></h3> <p>A common usage of an <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> is when the input sequence sizes vary according to an input sequence lengths (such as tokens).</p> <p>For example, the following sentences could result in two different sequence lengths after tokenization:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Input</span> <span class="n">text</span> <span class="o">=</span> <span class="p">[</span> <span class="s1">'Hello, sailor'</span><span class="p">,</span> <span class="s1">'Example'</span><span class="p">,</span> <span class="p">]</span> <span class="c1"># ... Tokenization ...</span> <span class="c1"># Result</span> <span class="n">tokens</span> <span class="o">=</span> <span class="p">[</span> <span class="p">[</span><span class="mi">101</span><span class="p">,</span> <span class="mi">7592</span><span class="p">,</span> <span class="mi">1010</span><span class="p">,</span> <span class="mi">11803</span><span class="p">,</span> <span class="mi">102</span><span class="p">],</span> <span class="p">[</span><span class="mi">101</span><span class="p">,</span> <span class="mi">2742</span><span class="p">,</span> <span class="mi">102</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">]</span> <span class="n">lengths</span> <span class="o">=</span> <span class="p">[</span><span class="mi">5</span><span class="p">,</span> <span class="mi">3</span><span class="p">]</span> </pre></div> </div> <p>Because the lengths are different, the final <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> state will be dependent upon the lengths of each sequence in the batch. Torch provides a way to deal with these types of sequences by densely packing batches into a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a>. The most common way this is constructed is by using the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pack_padded_sequence.html#torch.nn.utils.rnn.pack_padded_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pack_padded_sequence()</span></code></a> utility function prior to feeding inputs into the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a>.</p> <p>Packing the above sequences would result in the following data and batch size tensors.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">data</span> <span class="o">=</span> <span class="p">[</span><span class="mi">101</span><span class="p">,</span> <span class="mi">101</span><span class="p">,</span> <span class="mi">7592</span><span class="p">,</span> <span class="mi">2742</span><span class="p">,</span> <span class="mi">1010</span><span class="p">,</span> <span class="mi">102</span><span class="p">,</span> <span class="mi">11803</span><span class="p">,</span> <span class="mi">102</span><span class="p">]</span> <span class="n">batch_sizes</span> <span class="o">=</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">]</span> </pre></div> </div> <p>In addition to correctly computing final <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> state, using a packed sequence instead of a padded sequence also improves model performance on CPU. On Neuron, where computation is fixed to the maximum length ahead of time, <strong>this is does not improve performance</strong>.</p> <p>When an <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> is processing a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a>, it must do so in a descending sorted length order. To ensure that sequences are sorted, <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pack_padded_sequence.html#torch.nn.utils.rnn.pack_padded_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pack_padded_sequence()</span></code></a> provides an <code class="docutils literal notranslate"><span class="pre">enforce_sorted</span></code> flag. When <code class="docutils literal notranslate"><span class="pre">enforce_sorted</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, the input is <em>already expected</em> to contain sequences sorted by length in a decreasing order along the batch dimension. Note that this must be enforced in the application-level code but is only relevant when batch size &gt; 1.</p> <p>The following network can compile successfully because the input and output to the network are guaranteed to be a fixed shape. The input shape is expected to be a padded tensor and the output tensor is expected to be padded to the maximum sequence length using the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pad_packed_sequence()</span></code></a> function call:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="k">class</span> <span class="nc">Network</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">LSTM</span><span class="p">(</span><span class="n">input_size</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">hidden_size</span><span class="o">=</span><span class="mi">7</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="p">):</span> <span class="n">packed_input</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">rnn</span><span class="o">.</span><span class="n">pack_padded_sequence</span><span class="p">(</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="o">=</span><span class="n">lengths</span><span class="p">,</span> <span class="hll"> <span class="n">enforce_sorted</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> </span> <span class="p">)</span> <span class="n">packed_result</span><span class="p">,</span> <span class="p">(</span><span class="n">ht</span><span class="p">,</span> <span class="n">ct</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span><span class="p">(</span><span class="n">packed_input</span><span class="p">)</span> <span class="n">padded_result</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">rnn</span><span class="o">.</span><span class="n">pad_packed_sequence</span><span class="p">(</span><span class="n">packed_result</span><span class="p">)</span> <span class="k">return</span> <span class="n">padded_result</span><span class="p">,</span> <span class="n">ht</span><span class="p">,</span> <span class="n">ct</span> <span class="c1"># Example Inputs</span> <span class="n">seq_len</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">input_size</span> <span class="o">=</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="n">seq_len</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">input_size</span><span class="p">)</span> <span class="n">lengths</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([</span><span class="n">seq_len</span><span class="p">]</span> <span class="o">*</span> <span class="n">batch_size</span><span class="p">)</span> <span class="c1"># Trace</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">Network</span><span class="p">(),</span> <span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="p">))</span> </pre></div> </div> </div> <div class="section" id="packed-input-padded-output-unsorted-inputs"> <h3>Packed Input, Padded Output, <em>Unsorted</em> Inputs<a class="headerlink" href="#packed-input-padded-output-unsorted-inputs" title="Permalink to this headline">#</a></h3> <p>When <code class="docutils literal notranslate"><span class="pre">enforce_sorted</span></code> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, the input will be sorted unconditionally. This causes some CPU overhead on Neuron because unsupported operators will be inserted into the graph such as <code class="docutils literal notranslate"><span class="pre">aten::sort</span></code> and <code class="docutils literal notranslate"><span class="pre">aten::scatter_</span></code>. The <code class="docutils literal notranslate"><span class="pre">aten::lstm</span></code> operation can still be supported, but it will be less efficient than when <code class="docutils literal notranslate"><span class="pre">enforce_sorted</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p> <p>The following code is able to be traced, but results in the sorting operations running on CPU. This is not problematic in this case because the <code class="docutils literal notranslate"><span class="pre">aten::sort</span></code> and <code class="docutils literal notranslate"><span class="pre">aten::scatter_</span></code> are executed on CPU at the very beginning of the graph just prior to Neuron execution.</p> <p>Like the previous example, the call to <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pad_packed_sequence()</span></code></a> ensures that the output is a fixed-shape based on the maximum sequence length.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="k">class</span> <span class="nc">Network</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">LSTM</span><span class="p">(</span><span class="n">input_size</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">hidden_size</span><span class="o">=</span><span class="mi">7</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="p">):</span> <span class="n">packed_input</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">rnn</span><span class="o">.</span><span class="n">pack_padded_sequence</span><span class="p">(</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="o">=</span><span class="n">lengths</span><span class="p">,</span> <span class="hll"> <span class="n">enforce_sorted</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> </span> <span class="p">)</span> <span class="n">packed_result</span><span class="p">,</span> <span class="p">(</span><span class="n">ht</span><span class="p">,</span> <span class="n">ct</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span><span class="p">(</span><span class="n">packed_input</span><span class="p">)</span> <span class="n">padded_result</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">rnn</span><span class="o">.</span><span class="n">pad_packed_sequence</span><span class="p">(</span><span class="n">packed_result</span><span class="p">)</span> <span class="k">return</span> <span class="n">padded_result</span><span class="p">,</span> <span class="n">ht</span><span class="p">,</span> <span class="n">ct</span> <span class="c1"># Example Inputs</span> <span class="n">seq_len</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">input_size</span> <span class="o">=</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="n">seq_len</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">input_size</span><span class="p">)</span> <span class="n">lengths</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([</span><span class="n">seq_len</span><span class="p">]</span> <span class="o">*</span> <span class="n">batch_size</span><span class="p">)</span> <span class="c1"># Trace</span> <span class="n">trace</span> <span class="o">=</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">Network</span><span class="p">(),</span> <span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="p">))</span> </pre></div> </div> </div> <div class="section" id="packed-inputs-final-hidden-cell-state-only"> <h3>Packed Inputs, Final Hidden &amp; Cell State Only<a class="headerlink" href="#packed-inputs-final-hidden-cell-state-only" title="Permalink to this headline">#</a></h3> <p>When <strong>only</strong> the final <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> hidden &amp; cell state is used, it does not matter if the inputs are packed or unpacked since these state tensors will not vary in size.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="k">class</span> <span class="nc">Network</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">LSTM</span><span class="p">(</span><span class="n">input_size</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">hidden_size</span><span class="o">=</span><span class="mi">7</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="p">):</span> <span class="n">packed_input</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">rnn</span><span class="o">.</span><span class="n">pack_padded_sequence</span><span class="p">(</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="o">=</span><span class="n">lengths</span><span class="p">,</span> <span class="n">enforce_sorted</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="p">)</span> <span class="hll"> <span class="n">packed_output</span><span class="p">,</span> <span class="p">(</span><span class="n">ht</span><span class="p">,</span> <span class="n">ct</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span><span class="p">(</span><span class="n">packed_input</span><span class="p">)</span> </span><span class="hll"> <span class="k">return</span> <span class="n">ht</span><span class="p">,</span> <span class="n">ct</span> </span> <span class="c1"># Example Inputs</span> <span class="n">seq_len</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">input_size</span> <span class="o">=</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="n">seq_len</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">input_size</span><span class="p">)</span> <span class="n">lengths</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([</span><span class="n">seq_len</span><span class="p">]</span> <span class="o">*</span> <span class="n">batch_size</span><span class="p">)</span> <span class="c1"># Trace</span> <span class="n">trace</span> <span class="o">=</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">Network</span><span class="p">(),</span> <span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="p">))</span> </pre></div> </div> <p>Note that when the <code class="docutils literal notranslate"><span class="pre">packed_output</span></code> is unused, it does not need to be passed to the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pad_packed_sequence()</span></code></a> to enable the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> to be compiled.</p> </div> </div> <div class="section" id="unsupported-usage"> <h2>Unsupported Usage<a class="headerlink" href="#unsupported-usage" title="Permalink to this headline">#</a></h2> <p>Neuron does not support the use of a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a> outside of the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> operation and the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pad_packed_sequence()</span></code></a> operation. This is because the shape of a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a> can vary depending on the input data. This is incompatible with the Neuron restriction that all tensor sizes must be known at compilation time. When a <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a> is used only by an <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> or <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pad_packed_sequence()</span></code></a> operation, Neuron <em>can guarantee</em> the size of the intermediary tensors by padding on behalf of the application.</p> <p>This means that If the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a> is either used by a different operation or returned from the network this would result in all of the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> operations to be executed on CPU or the network compilation will fail.</p> <div class="section" id="packedsequence-returned"> <h3><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a> Returned<a class="headerlink" href="#packedsequence-returned" title="Permalink to this headline">#</a></h3> <p>The following is unsupported because the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a> result of the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> is returned by the network:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Network</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">LSTM</span><span class="p">(</span><span class="n">input_size</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">hidden_size</span><span class="o">=</span><span class="mi">7</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="p">):</span> <span class="n">packed_input</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">rnn</span><span class="o">.</span><span class="n">pack_padded_sequence</span><span class="p">(</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="o">=</span><span class="n">lengths</span><span class="p">,</span> <span class="n">enforce_sorted</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="p">)</span> <span class="n">packed_result</span><span class="p">,</span> <span class="p">(</span><span class="n">ht</span><span class="p">,</span> <span class="n">ct</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span><span class="p">(</span><span class="n">packed_input</span><span class="p">)</span> <span class="hll"> <span class="k">return</span> <span class="n">packed_result</span><span class="o">.</span><span class="n">data</span><span class="p">,</span> <span class="n">ht</span><span class="p">,</span> <span class="n">ct</span> </span></pre></div> </div> <p><strong>Behavior</strong>: In this case, compilation fails and the following warning is generated:</p> <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Operator "aten::lstm" consuming a PackedSequence input can only be supported when its corresponding PackedSequence output is unused or unpacked using "aten::_pad_packed_input". Found usage by "prim::Return" </pre></div> </div> <p><strong>Resolution</strong>: To avoid this error, the <code class="docutils literal notranslate"><span class="pre">packed_result</span></code> should be padded prior to being returned from the network by using <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pad_packed_sequence()</span></code></a></p> </div> <div class="section" id="invalid-packedsequence-usage"> <h3>Invalid <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a> Usage<a class="headerlink" href="#invalid-packedsequence-usage" title="Permalink to this headline">#</a></h3> <p>The following is unsupported because the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.PackedSequence.html#torch.nn.utils.rnn.PackedSequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackedSequence</span></code></a> result of the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.LSTM.html#torch.nn.LSTM" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code></a> is used by a non-LSTM operator:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Network</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">LSTM</span><span class="p">(</span><span class="n">input_size</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">hidden_size</span><span class="o">=</span><span class="mi">7</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="p">):</span> <span class="n">packed_input</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">rnn</span><span class="o">.</span><span class="n">pack_padded_sequence</span><span class="p">(</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">lengths</span><span class="o">=</span><span class="n">lengths</span><span class="p">,</span> <span class="n">enforce_sorted</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="p">)</span> <span class="n">packed_result</span><span class="p">,</span> <span class="p">(</span><span class="n">ht</span><span class="p">,</span> <span class="n">ct</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lstm</span><span class="p">(</span><span class="n">packed_input</span><span class="p">)</span> <span class="hll"> <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">packed_result</span><span class="o">.</span><span class="n">data</span><span class="p">)</span> </span></pre></div> </div> <p><strong>Behavior</strong>: In this case, compilation fails and the following warning is generated:</p> <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Operator "aten::lstm" consuming a PackedSequence input can only be supported when its corresponding PackedSequence output is unused or unpacked using "aten::_pad_packed_input". Found usage by "aten::max" </pre></div> </div> <p><strong>Resolution</strong>: To avoid this error, the <code class="docutils literal notranslate"><span class="pre">packed_result</span></code> should be padded prior to being used in the <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.max.html#torch.max" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">max()</span></code></a> from the network by using <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.utils.rnn.pad_packed_sequence.html#torch.nn.utils.rnn.pad_packed_sequence" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">pad_packed_sequence()</span></code></a>.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Data Parallel Inference on Torch Neuron</p> </div> </a> <a class="right-next" id="next-link" href="core-placement/torch-core-placement.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Core Placement</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:52:59.801Z
Running inference on variable input shapes with bucketing — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/general/appnotes/torch-neuron/bucketing-app-note.html
# Running inference on variable input shapes with bucketing — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## Running inference on variable input shapes with bucketing[#](#running-inference-on-variable-input-shapes-with-bucketing "Permalink to this headline") Table of contents - [Introduction](#introduction) - [Applications that benefit from bucketing](#applications-that-benefit-from-bucketing) - [Implementing bucketing](#implementing-bucketing) - [Creating bucketed models](#creating-bucketed-models) - [Running inference with bucketing](#running-inference-with-bucketing) - [Examples](#examples) - [Computer vision bucketing](#computer-vision-bucketing) - [End-to-end computer vision bucketing example](#end-to-end-computer-vision-bucketing-example) - [Natural language processing bucketing](#natural-language-processing-bucketing) - [End-to-end natural language processing bucketing example](#end-to-end-natural-language-processing-bucketing-example) ## [Introduction](#id1)[#](#introduction "Permalink to this headline") With Inferentia, the shape of every input must be fixed at compile time. For applications that require multiple input sizes, we recommend using padding or bucketing techniques. Padding requires you to compile your model with the largest expected input size and pad every input to this maximum size. If the performance of your model using padding is not within your targets, you can consider implementing bucketing. This guide introduces bucketing, a technique to run inference on inputs with variable shapes on Inferentia. The following sections explain how bucketing can improve the performance of inference workloads on Inferentia. It covers an overview of how bucketing works and provides examples of using bucketing in [computer vision](#bucketing-example-cv) and [natural language processing](#bucketing-example-nlp) applications. ## [Applications that benefit from bucketing](#id2)[#](#applications-that-benefit-from-bucketing "Permalink to this headline") Bucketing refers to compiling your model multiple times with different target input shapes to create “bucketed models.” [Creating bucketed models](#creating-buckets) provides an overview on selecting the input shapes that you use to create bucketed models. At inference time, each input is padded until its shape matches the next largest bucket shape. The padded input is then passed into the corresponding bucketed model for inference. By compiling the same model with multiple different input shapes, the amount of input padding is reduced compared to padding every input to the maximum size in your dataset. This technique minimizes the compute overhead and improves inference performance compared to padding every image to the maximum shape in your dataset. Bucketing works best when multiple different bucketed models are created to efficiently cover the full range of input shapes. You can fine-tune the model performance by experimenting with different bucket sizes that correspond to the distribution of input shapes in your dataset. Bucketing can only be used if there is an upper bound on the shape of the inputs. If necessary, an upper bound on the input shape can be enforced using resizing and other forms of preprocessing. The upper bound on the number of bucketed models that you use is dictated by the total size of the compiled bucketed models. Each Inferentia chip has 8GB of DRAM, or 2GB of DRAM per NeuronCore. An inf1.xlarge and inf1.2xlarge have 1 Inferentia chip, an inf1.6xlarge has 4 Inferentia chips, and an inf1.24xlarge has 16 Inferentia chips. Thus, you should limit the total size of all bucketed models to around 8GB per Inferentia chip or 2GB per NeuronCore. The following formula provides an approximation for the number of compiled bucketed models you can fit on each NeuronCore: ``` number-of-buckets = round(10^9 / number-of-weights-in-model) ``` We recommend using [neuron-top](../../../tools/neuron-sys-tools/neuron-top-user-guide.html#neuron-top-ug) to monitor the memory usage on your inf1 instance as you load multiple bucketed models. ## [Implementing bucketing](#id3)[#](#implementing-bucketing "Permalink to this headline") Implementing bucketing consists of two main parts: creating multiple bucketed models at compile-time and running inference using the bucketed models on (padded) inputs. The following sections describe how to implement bucketing to run inference in applications that have variable input shapes. ### [Creating bucketed models](#id4)[#](#creating-bucketed-models "Permalink to this headline") Before running inference, models should be compiled for different input shapes that are representative of the input dataset. The input shapes that are used to compile the models determine the bucket shapes that are used during inference. The bucket shapes should be chosen to minimize the amount of padding on each new input. Additionally, there should always be a bucket that’s large enough to handle the maximum input shape in the dataset. The limit on the number of compiled bucketed models that can be used is described in this [section](#num-buckets). ### [Running inference with bucketing](#id5)[#](#running-inference-with-bucketing "Permalink to this headline") At inference time, each input should be padded to match the size of the next largest bucket, such that the height and width (or sequence length) of the padded input equals the size of the bucket. Then, the padded input should be passed into the corresponding bucket for inference. If necessary, it’s important to remove and/or crop any aberrant predictions that occur in the padded region. For example, in object detection applications, bounding box predictions that occur in the padded regions should be removed to avoid erroneous predictions. ## [Examples](#id6)[#](#examples "Permalink to this headline") The following sections provide examples of applying the bucketing technique to run inference in applications that have variable input shapes. ### [Computer vision bucketing](#id7)[#](#computer-vision-bucketing "Permalink to this headline") As an example of implementing bucketing for computer vision models, consider an application where the height and width of images in dataset are uniformly distributed between \[400, 400\] and \[800, 800\]. Given that every input shape between \[400, 400\] and \[800, 800\] is equally likely, it could make sense to create bucketed models that divide up the range of input shapes into equally sized chunks. For example, we could create bucketed models for the input shapes \[500, 500\], \[600, 600\], \[700, 700\], and \[800, 800\]. As an example of running inference with bucketing, let’s assume that we created bucketed models for the input shapes \[500, 500\], \[600, 600\], \[700, 700\], and \[800, 800\]. If we receive an input with shape \[640, 640\], we would pad the input to the next largest bucket, \[700, 700\], and use this bucket for inference. If we receive an input with shape \[440, 540\], we would need to pad the input to the bucket size, \[600, 600\], and use this bucket for inference. As another example of creating bucketed models, consider a computer vision application where the dataset is not uniformly distributed. As before, let’s assume the input shapes range between \[400, 400\] to \[800, 800\]. Now, let’s assume the data shape distribution is bimodal, such that \[540, 540\] and \[720, 720\] are the two most common input shapes. In this example, it might make sense to create bucketed models for input shapes \[540, 540\], \[720, 720\], and \[800, 800\] to target the most common shapes while still including the entire range of input shapes. ### [End-to-end computer vision bucketing example](#id8)[#](#end-to-end-computer-vision-bucketing-example "Permalink to this headline") In this example, we run inference in a computer vision application that has variable shaped images that range in shape from \[400, 400\] to \[800, 800\]. We create bucketed models for the input shapes \[500, 500\], \[600, 600\], \[700, 700\], and \[800, 800\] to handle the variable input shapes. ``` import numpy as np import torch from torchvision import models import torch_neuron # Load the model and set it to evaluation mode model = models.resnet50(pretrained=True) model.eval() # Define the bucket sizes that will be used for compilation and inference bucket_sizes = [(500, 500), (600, 600), (700, 700), (800, 800)] # Create the bucketed models by compiling a model for each bucket size buckets = {} for bucket_size in bucket_sizes: # Create an example input that is the desired bucket size h, w = bucket_size image = torch.rand([1, 3, h, w]) # Compile with the example input to create the bucketed model model_neuron = torch.neuron.trace(model, image) # Run a warm up inference to load the model into Inferentia memory model_neuron(image) # Add the bucketed model based on its bucket size buckets[bucket_size] = model_neuron def get_bucket_and_pad_image(image): # Determine which bucket size to use oh, ow = image.shape[-2:] target_bucket = None for bucket_size in bucket_sizes: # Choose a bucket that's larger in both the height and width dimensions if oh <= bucket_size[0] and ow <= bucket_size[1]: target_bucket = bucket_size break # Pad the image to match the size of the bucket h_delta = target_bucket[0] - oh w_delta = target_bucket[1] - ow b_pad = h_delta # Bottom padding l_pad = 0 # Left padding t_pad = 0 # Top padding r_pad = w_delta # Right padding # Pad the height and width of the image padding_amounts = (l_pad, r_pad, t_pad, b_pad) image_padded = torch.nn.functional.pad(image, padding_amounts, value=0) return image_padded, target_bucket # Run inference on inputs with different shapes for _ in range(10): # Create an image with a random height and width in range [400, 400] to [800, 800] h = int(np.random.uniform(low=400, high=800)) w = int(np.random.uniform(low=400, high=800)) image = torch.rand(1, 3, h, w) # Determine bucket and pad the image image_padded, target_bucket = get_bucket_and_pad_image(image) # Use the corresponding bucket to run inference output = buckets[target_bucket](image_padded) ``` ### [Natural language processing bucketing](#id9)[#](#natural-language-processing-bucketing "Permalink to this headline") As an example of implementing bucketing for natural language processing models, consider an application where the lengths of tokenized sequences in a dataset are uniformly distributed between 0 and 128 tokens. Given that every tokenized sequence length between 0 and 128 is equally likely, it might make sense to create bucketed models that divide up the range of tokenized sequence lengths into equally sized chunks. For example, we could create bucketed models for tokenized sequence lengths 64 and 128. As an example of running inference with bucketing, let’s assume that we created bucketed models for the input tokenized sequence lengths 64 and 128. If we receive a tokenized sequence with length 55, we would need to pad it to the bucket size 64 and use this bucket for inference. If we receive a tokenized sequence with length 112, we would need to pad it to the bucket size 128 and use this bucket for inference. ### [End-to-end natural language processing bucketing example](#id10)[#](#end-to-end-natural-language-processing-bucketing-example "Permalink to this headline") In this example, we run inference in a natural language processing application that has variable length tokenized sequences that range from 0 to 128. We create bucketed models for lengths 64 and 128 to handle the variable input lengths. ``` import numpy as np import torch from transformers import AutoTokenizer, AutoModelForSequenceClassification import torch_neuron # Build tokenizer and model tokenizer = AutoTokenizer.from_pretrained("bert-base-cased-finetuned-mrpc") model = AutoModelForSequenceClassification.from_pretrained("bert-base-cased-finetuned-mrpc", return_dict=False) model.eval() # Define the bucket sizes that will be used for compilation and inference bucket_sizes = [64, 128] # Create the bucketed models by compiling a model for each bucket size buckets = {} for bucket_size in bucket_sizes: # Setup some example inputs sequence_0 = "The company HuggingFace is based in New York City" sequence_1 = "HuggingFace's headquarters are situated in Manhattan" # Create an example input that is the desired bucket size paraphrase = tokenizer.encode_plus(sequence_0, sequence_1, max_length=bucket_size, padding='max_length', truncation=True, return_tensors="pt") # Convert example inputs to a format that is compatible with TorchScript tracing example_inputs_paraphrase = paraphrase['input_ids'], paraphrase['attention_mask'], paraphrase['token_type_ids'] # Compile with the example input to create the bucketed model model_neuron = torch.neuron.trace(model, example_inputs_paraphrase) # Run a warm up inference to load the model into Inferentia memory model_neuron(*example_inputs_paraphrase) # Add the bucketed model based on its bucket size buckets[bucket_size] = model_neuron def get_bucket_and_pad_paraphrase(paraphrase): # Determine which bucket size to use inputs = paraphrase['input_ids'] attention = paraphrase['attention_mask'] token_type = paraphrase['token_type_ids'] paraphrase_len = inputs.shape[1] target_bucket = None for bucket_size in bucket_sizes: if paraphrase_len <= bucket_size: target_bucket = bucket_size break # Pad the paraphrase to match the size of the bucket delta = target_bucket - paraphrase_len zeros = torch.zeros([1, delta], dtype=torch.long) inputs = torch.cat([inputs, zeros], dim=1) attention = torch.cat([attention, zeros], dim=1) token_type = torch.cat([token_type, zeros], dim=1) paraphrase_padded = inputs, attention, token_type return paraphrase_padded, target_bucket # Create two sample sequences sequence_0 = ("The only other bear similar in size to the polar bear is the " "Kodiak bear, which is a subspecies of the brown bear. Adult male " "polar bears weigh 350–700 kg and measure 2.4–3 meters in total " "length. All bears are short-tailed, the polar bear's tail is " "relatively the shortest amongst living bears.") sequence_1 = ("Around the Beaufort Sea, however, mature males reportedly " "average 450 kg. Adult females are roughly half the size of males " "and normally weigh 150–250 kg, measuring 1.8–2.4 meters in length. " "The legs are stocky and the ears and tail are small.") # Run inference on inputs with different shapes # We create the variable shapes by randomly cropping the sequences for _ in range(10): # Get random sequence lengths between 0 and 128 paraphrase_len = int(np.random.uniform(128)) # Crop the paraphrase paraphrase_cropped = tokenizer.encode_plus(sequence_0, sequence_1, max_length=paraphrase_len, padding='max_length', truncation=True, return_tensors="pt") # Determine bucket and pad the paraphrase paraphrase_padded, target_bucket = get_bucket_and_pad_paraphrase(paraphrase_cropped) # Use the corresponding bucket to run inference output = buckets[target_bucket](*paraphrase_padded) ``` _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Running inference on variable input shapes with bucketing — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Data Parallel Inference on Torch Neuron" href="torch-neuron-dataparallel-app-note.html"> <link rel="prev" title="Developer Guide (torch-neuron)" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "general/appnotes/torch-neuron/bucketing-app-note", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fgeneral/appnotes/torch-neuron/bucketing-app-note.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/general/appnotes/torch-neuron/bucketing-app-note.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/general/appnotes/torch-neuron/bucketing-app-note.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#applications-that-benefit-from-bucketing"> Applications that benefit from bucketing </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#implementing-bucketing"> Implementing bucketing </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#creating-bucketed-models"> Creating bucketed models </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#running-inference-with-bucketing"> Running inference with bucketing </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#computer-vision-bucketing"> Computer vision bucketing </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#end-to-end-computer-vision-bucketing-example"> End-to-end computer vision bucketing example </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#natural-language-processing-bucketing"> Natural language processing bucketing </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#end-to-end-natural-language-processing-bucketing-example"> End-to-end natural language processing bucketing example </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Running inference on variable input shapes with bucketing</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#applications-that-benefit-from-bucketing"> Applications that benefit from bucketing </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#implementing-bucketing"> Implementing bucketing </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#creating-bucketed-models"> Creating bucketed models </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#running-inference-with-bucketing"> Running inference with bucketing </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#examples"> Examples </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#computer-vision-bucketing"> Computer vision bucketing </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#end-to-end-computer-vision-bucketing-example"> End-to-end computer vision bucketing example </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#natural-language-processing-bucketing"> Natural language processing bucketing </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#end-to-end-natural-language-processing-bucketing-example"> End-to-end natural language processing bucketing example </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="running-inference-on-variable-input-shapes-with-bucketing"> <span id="bucketing-app-note"></span><h1>Running inference on variable input shapes with bucketing<a class="headerlink" href="#running-inference-on-variable-input-shapes-with-bucketing" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#introduction" id="id1">Introduction</a></p></li> <li><p><a class="reference internal" href="#applications-that-benefit-from-bucketing" id="id2">Applications that benefit from bucketing</a></p></li> <li><p><a class="reference internal" href="#implementing-bucketing" id="id3">Implementing bucketing</a></p> <ul> <li><p><a class="reference internal" href="#creating-bucketed-models" id="id4">Creating bucketed models</a></p></li> <li><p><a class="reference internal" href="#running-inference-with-bucketing" id="id5">Running inference with bucketing</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#examples" id="id6">Examples</a></p> <ul> <li><p><a class="reference internal" href="#computer-vision-bucketing" id="id7">Computer vision bucketing</a></p></li> <li><p><a class="reference internal" href="#end-to-end-computer-vision-bucketing-example" id="id8">End-to-end computer vision bucketing example</a></p></li> <li><p><a class="reference internal" href="#natural-language-processing-bucketing" id="id9">Natural language processing bucketing</a></p></li> <li><p><a class="reference internal" href="#end-to-end-natural-language-processing-bucketing-example" id="id10">End-to-end natural language processing bucketing example</a></p></li> </ul> </li> </ul> </div> <div class="section" id="introduction"> <h2><a class="toc-backref" href="#id1">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">#</a></h2> <p>With Inferentia, the shape of every input must be fixed at compile time. For applications that require multiple input sizes, we recommend using padding or bucketing techniques. Padding requires you to compile your model with the largest expected input size and pad every input to this maximum size. If the performance of your model using padding is not within your targets, you can consider implementing bucketing.</p> <p>This guide introduces bucketing, a technique to run inference on inputs with variable shapes on Inferentia. The following sections explain how bucketing can improve the performance of inference workloads on Inferentia. It covers an overview of how bucketing works and provides examples of using bucketing in <a class="reference internal" href="#bucketing-example-cv"><span class="std std-ref">computer vision</span></a> and <a class="reference internal" href="#bucketing-example-nlp"><span class="std std-ref">natural language processing</span></a> applications.</p> </div> <div class="section" id="applications-that-benefit-from-bucketing"> <h2><a class="toc-backref" href="#id2">Applications that benefit from bucketing</a><a class="headerlink" href="#applications-that-benefit-from-bucketing" title="Permalink to this headline">#</a></h2> <p>Bucketing refers to compiling your model multiple times with different target input shapes to create “bucketed models.” <a class="reference internal" href="#creating-buckets"><span class="std std-ref">Creating bucketed models</span></a> provides an overview on selecting the input shapes that you use to create bucketed models. At inference time, each input is padded until its shape matches the next largest bucket shape. The padded input is then passed into the corresponding bucketed model for inference. By compiling the same model with multiple different input shapes, the amount of input padding is reduced compared to padding every input to the maximum size in your dataset. This technique minimizes the compute overhead and improves inference performance compared to padding every image to the maximum shape in your dataset.</p> <p>Bucketing works best when multiple different bucketed models are created to efficiently cover the full range of input shapes. You can fine-tune the model performance by experimenting with different bucket sizes that correspond to the distribution of input shapes in your dataset.</p> <p>Bucketing can only be used if there is an upper bound on the shape of the inputs. If necessary, an upper bound on the input shape can be enforced using resizing and other forms of preprocessing.</p> <p id="num-buckets">The upper bound on the number of bucketed models that you use is dictated by the total size of the compiled bucketed models. Each Inferentia chip has 8GB of DRAM, or 2GB of DRAM per NeuronCore. An inf1.xlarge and inf1.2xlarge have 1 Inferentia chip, an inf1.6xlarge has 4 Inferentia chips, and an inf1.24xlarge has 16 Inferentia chips. Thus, you should limit the total size of all bucketed models to around 8GB per Inferentia chip or 2GB per NeuronCore. The following formula provides an approximation for the number of compiled bucketed models you can fit on each NeuronCore:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">number</span><span class="o">-</span><span class="n">of</span><span class="o">-</span><span class="n">buckets</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">10</span><span class="o">^</span><span class="mi">9</span> <span class="o">/</span> <span class="n">number</span><span class="o">-</span><span class="n">of</span><span class="o">-</span><span class="n">weights</span><span class="o">-</span><span class="ow">in</span><span class="o">-</span><span class="n">model</span><span class="p">)</span> </pre></div> </div> <p>We recommend using <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html#neuron-top-ug"><span class="std std-ref">neuron-top</span></a> to monitor the memory usage on your inf1 instance as you load multiple bucketed models.</p> </div> <div class="section" id="implementing-bucketing"> <h2><a class="toc-backref" href="#id3">Implementing bucketing</a><a class="headerlink" href="#implementing-bucketing" title="Permalink to this headline">#</a></h2> <p>Implementing bucketing consists of two main parts: creating multiple bucketed models at compile-time and running inference using the bucketed models on (padded) inputs. The following sections describe how to implement bucketing to run inference in applications that have variable input shapes.</p> <div class="section" id="creating-bucketed-models"> <span id="creating-buckets"></span><h3><a class="toc-backref" href="#id4">Creating bucketed models</a><a class="headerlink" href="#creating-bucketed-models" title="Permalink to this headline">#</a></h3> <p>Before running inference, models should be compiled for different input shapes that are representative of the input dataset. The input shapes that are used to compile the models determine the bucket shapes that are used during inference. The bucket shapes should be chosen to minimize the amount of padding on each new input. Additionally, there should always be a bucket that’s large enough to handle the maximum input shape in the dataset. The limit on the number of compiled bucketed models that can be used is described in this <a class="reference internal" href="#num-buckets"><span class="std std-ref">section</span></a>.</p> </div> <div class="section" id="running-inference-with-bucketing"> <h3><a class="toc-backref" href="#id5">Running inference with bucketing</a><a class="headerlink" href="#running-inference-with-bucketing" title="Permalink to this headline">#</a></h3> <p>At inference time, each input should be padded to match the size of the next largest bucket, such that the height and width (or sequence length) of the padded input equals the size of the bucket. Then, the padded input should be passed into the corresponding bucket for inference. If necessary, it’s important to remove and/or crop any aberrant predictions that occur in the padded region. For example, in object detection applications, bounding box predictions that occur in the padded regions should be removed to avoid erroneous predictions.</p> </div> </div> <div class="section" id="examples"> <span id="bucketing-examples"></span><h2><a class="toc-backref" href="#id6">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline">#</a></h2> <p>The following sections provide examples of applying the bucketing technique to run inference in applications that have variable input shapes.</p> <div class="section" id="computer-vision-bucketing"> <span id="bucketing-example-cv"></span><h3><a class="toc-backref" href="#id7">Computer vision bucketing</a><a class="headerlink" href="#computer-vision-bucketing" title="Permalink to this headline">#</a></h3> <p>As an example of implementing bucketing for computer vision models, consider an application where the height and width of images in dataset are uniformly distributed between <cite>[400, 400]</cite> and <cite>[800, 800]</cite>. Given that every input shape between <cite>[400, 400]</cite> and <cite>[800, 800]</cite> is equally likely, it could make sense to create bucketed models that divide up the range of input shapes into equally sized chunks. For example, we could create bucketed models for the input shapes <cite>[500, 500]</cite>, <cite>[600, 600]</cite>, <cite>[700, 700]</cite>, and <cite>[800, 800]</cite>.</p> <p>As an example of running inference with bucketing, let’s assume that we created bucketed models for the input shapes <cite>[500, 500]</cite>, <cite>[600, 600]</cite>, <cite>[700, 700]</cite>, and <cite>[800, 800]</cite>. If we receive an input with shape <cite>[640, 640]</cite>, we would pad the input to the next largest bucket, <cite>[700, 700]</cite>, and use this bucket for inference. If we receive an input with shape <cite>[440, 540]</cite>, we would need to pad the input to the bucket size, <cite>[600, 600]</cite>, and use this bucket for inference.</p> <p>As another example of creating bucketed models, consider a computer vision application where the dataset is not uniformly distributed. As before, let’s assume the input shapes range between <cite>[400, 400]</cite> to <cite>[800, 800]</cite>. Now, let’s assume the data shape distribution is bimodal, such that <cite>[540, 540]</cite> and <cite>[720, 720]</cite> are the two most common input shapes. In this example, it might make sense to create bucketed models for input shapes <cite>[540, 540]</cite>, <cite>[720, 720]</cite>, and <cite>[800, 800]</cite> to target the most common shapes while still including the entire range of input shapes.</p> </div> <div class="section" id="end-to-end-computer-vision-bucketing-example"> <h3><a class="toc-backref" href="#id8">End-to-end computer vision bucketing example</a><a class="headerlink" href="#end-to-end-computer-vision-bucketing-example" title="Permalink to this headline">#</a></h3> <p>In this example, we run inference in a computer vision application that has variable shaped images that range in shape from <cite>[400, 400]</cite> to <cite>[800, 800]</cite>. We create bucketed models for the input shapes <cite>[500, 500]</cite>, <cite>[600, 600]</cite>, <cite>[700, 700]</cite>, and <cite>[800, 800]</cite> to handle the variable input shapes.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">from</span> <span class="nn">torchvision</span> <span class="kn">import</span> <span class="n">models</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="c1"># Load the model and set it to evaluation mode</span> <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">resnet50</span><span class="p">(</span><span class="n">pretrained</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Define the bucket sizes that will be used for compilation and inference</span> <span class="n">bucket_sizes</span> <span class="o">=</span> <span class="p">[(</span><span class="mi">500</span><span class="p">,</span> <span class="mi">500</span><span class="p">),</span> <span class="p">(</span><span class="mi">600</span><span class="p">,</span> <span class="mi">600</span><span class="p">),</span> <span class="p">(</span><span class="mi">700</span><span class="p">,</span> <span class="mi">700</span><span class="p">),</span> <span class="p">(</span><span class="mi">800</span><span class="p">,</span> <span class="mi">800</span><span class="p">)]</span> <span class="c1"># Create the bucketed models by compiling a model for each bucket size</span> <span class="n">buckets</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">for</span> <span class="n">bucket_size</span> <span class="ow">in</span> <span class="n">bucket_sizes</span><span class="p">:</span> <span class="c1"># Create an example input that is the desired bucket size</span> <span class="n">h</span><span class="p">,</span> <span class="n">w</span> <span class="o">=</span> <span class="n">bucket_size</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">w</span><span class="p">])</span> <span class="c1"># Compile with the example input to create the bucketed model</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span> <span class="c1"># Run a warm up inference to load the model into Inferentia memory</span> <span class="n">model_neuron</span><span class="p">(</span><span class="n">image</span><span class="p">)</span> <span class="c1"># Add the bucketed model based on its bucket size</span> <span class="n">buckets</span><span class="p">[</span><span class="n">bucket_size</span><span class="p">]</span> <span class="o">=</span> <span class="n">model_neuron</span> <span class="k">def</span> <span class="nf">get_bucket_and_pad_image</span><span class="p">(</span><span class="n">image</span><span class="p">):</span> <span class="c1"># Determine which bucket size to use</span> <span class="n">oh</span><span class="p">,</span> <span class="n">ow</span> <span class="o">=</span> <span class="n">image</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">:]</span> <span class="n">target_bucket</span> <span class="o">=</span> <span class="kc">None</span> <span class="k">for</span> <span class="n">bucket_size</span> <span class="ow">in</span> <span class="n">bucket_sizes</span><span class="p">:</span> <span class="c1"># Choose a bucket that's larger in both the height and width dimensions</span> <span class="k">if</span> <span class="n">oh</span> <span class="o">&lt;=</span> <span class="n">bucket_size</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">and</span> <span class="n">ow</span> <span class="o">&lt;=</span> <span class="n">bucket_size</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">target_bucket</span> <span class="o">=</span> <span class="n">bucket_size</span> <span class="k">break</span> <span class="c1"># Pad the image to match the size of the bucket</span> <span class="n">h_delta</span> <span class="o">=</span> <span class="n">target_bucket</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="n">oh</span> <span class="n">w_delta</span> <span class="o">=</span> <span class="n">target_bucket</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">ow</span> <span class="n">b_pad</span> <span class="o">=</span> <span class="n">h_delta</span> <span class="c1"># Bottom padding</span> <span class="n">l_pad</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1"># Left padding</span> <span class="n">t_pad</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1"># Top padding</span> <span class="n">r_pad</span> <span class="o">=</span> <span class="n">w_delta</span> <span class="c1"># Right padding</span> <span class="c1"># Pad the height and width of the image</span> <span class="n">padding_amounts</span> <span class="o">=</span> <span class="p">(</span><span class="n">l_pad</span><span class="p">,</span> <span class="n">r_pad</span><span class="p">,</span> <span class="n">t_pad</span><span class="p">,</span> <span class="n">b_pad</span><span class="p">)</span> <span class="n">image_padded</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">functional</span><span class="o">.</span><span class="n">pad</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">padding_amounts</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="k">return</span> <span class="n">image_padded</span><span class="p">,</span> <span class="n">target_bucket</span> <span class="c1"># Run inference on inputs with different shapes</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">10</span><span class="p">):</span> <span class="c1"># Create an image with a random height and width in range [400, 400] to [800, 800]</span> <span class="n">h</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">400</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">800</span><span class="p">))</span> <span class="n">w</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">400</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">800</span><span class="p">))</span> <span class="n">image</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">w</span><span class="p">)</span> <span class="c1"># Determine bucket and pad the image</span> <span class="n">image_padded</span><span class="p">,</span> <span class="n">target_bucket</span> <span class="o">=</span> <span class="n">get_bucket_and_pad_image</span><span class="p">(</span><span class="n">image</span><span class="p">)</span> <span class="c1"># Use the corresponding bucket to run inference</span> <span class="n">output</span> <span class="o">=</span> <span class="n">buckets</span><span class="p">[</span><span class="n">target_bucket</span><span class="p">](</span><span class="n">image_padded</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="natural-language-processing-bucketing"> <span id="bucketing-example-nlp"></span><h3><a class="toc-backref" href="#id9">Natural language processing bucketing</a><a class="headerlink" href="#natural-language-processing-bucketing" title="Permalink to this headline">#</a></h3> <p>As an example of implementing bucketing for natural language processing models, consider an application where the lengths of tokenized sequences in a dataset are uniformly distributed between 0 and 128 tokens. Given that every tokenized sequence length between 0 and 128 is equally likely, it might make sense to create bucketed models that divide up the range of tokenized sequence lengths into equally sized chunks. For example, we could create bucketed models for tokenized sequence lengths 64 and 128.</p> <p>As an example of running inference with bucketing, let’s assume that we created bucketed models for the input tokenized sequence lengths 64 and 128. If we receive a tokenized sequence with length 55, we would need to pad it to the bucket size 64 and use this bucket for inference. If we receive a tokenized sequence with length 112, we would need to pad it to the bucket size 128 and use this bucket for inference.</p> </div> <div class="section" id="end-to-end-natural-language-processing-bucketing-example"> <h3><a class="toc-backref" href="#id10">End-to-end natural language processing bucketing example</a><a class="headerlink" href="#end-to-end-natural-language-processing-bucketing-example" title="Permalink to this headline">#</a></h3> <p>In this example, we run inference in a natural language processing application that has variable length tokenized sequences that range from 0 to 128. We create bucketed models for lengths 64 and 128 to handle the variable input lengths.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">AutoTokenizer</span><span class="p">,</span> <span class="n">AutoModelForSequenceClassification</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="c1"># Build tokenizer and model</span> <span class="n">tokenizer</span> <span class="o">=</span> <span class="n">AutoTokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="s2">"bert-base-cased-finetuned-mrpc"</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">AutoModelForSequenceClassification</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="s2">"bert-base-cased-finetuned-mrpc"</span><span class="p">,</span> <span class="n">return_dict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Define the bucket sizes that will be used for compilation and inference</span> <span class="n">bucket_sizes</span> <span class="o">=</span> <span class="p">[</span><span class="mi">64</span><span class="p">,</span> <span class="mi">128</span><span class="p">]</span> <span class="c1"># Create the bucketed models by compiling a model for each bucket size</span> <span class="n">buckets</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">for</span> <span class="n">bucket_size</span> <span class="ow">in</span> <span class="n">bucket_sizes</span><span class="p">:</span> <span class="c1"># Setup some example inputs</span> <span class="n">sequence_0</span> <span class="o">=</span> <span class="s2">"The company HuggingFace is based in New York City"</span> <span class="n">sequence_1</span> <span class="o">=</span> <span class="s2">"HuggingFace's headquarters are situated in Manhattan"</span> <span class="c1"># Create an example input that is the desired bucket size</span> <span class="n">paraphrase</span> <span class="o">=</span> <span class="n">tokenizer</span><span class="o">.</span><span class="n">encode_plus</span><span class="p">(</span><span class="n">sequence_0</span><span class="p">,</span> <span class="n">sequence_1</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">bucket_size</span><span class="p">,</span> <span class="n">padding</span><span class="o">=</span><span class="s1">'max_length'</span><span class="p">,</span> <span class="n">truncation</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">return_tensors</span><span class="o">=</span><span class="s2">"pt"</span><span class="p">)</span> <span class="c1"># Convert example inputs to a format that is compatible with TorchScript tracing</span> <span class="n">example_inputs_paraphrase</span> <span class="o">=</span> <span class="n">paraphrase</span><span class="p">[</span><span class="s1">'input_ids'</span><span class="p">],</span> <span class="n">paraphrase</span><span class="p">[</span><span class="s1">'attention_mask'</span><span class="p">],</span> <span class="n">paraphrase</span><span class="p">[</span><span class="s1">'token_type_ids'</span><span class="p">]</span> <span class="c1"># Compile with the example input to create the bucketed model</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example_inputs_paraphrase</span><span class="p">)</span> <span class="c1"># Run a warm up inference to load the model into Inferentia memory</span> <span class="n">model_neuron</span><span class="p">(</span><span class="o">*</span><span class="n">example_inputs_paraphrase</span><span class="p">)</span> <span class="c1"># Add the bucketed model based on its bucket size</span> <span class="n">buckets</span><span class="p">[</span><span class="n">bucket_size</span><span class="p">]</span> <span class="o">=</span> <span class="n">model_neuron</span> <span class="k">def</span> <span class="nf">get_bucket_and_pad_paraphrase</span><span class="p">(</span><span class="n">paraphrase</span><span class="p">):</span> <span class="c1"># Determine which bucket size to use</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">paraphrase</span><span class="p">[</span><span class="s1">'input_ids'</span><span class="p">]</span> <span class="n">attention</span> <span class="o">=</span> <span class="n">paraphrase</span><span class="p">[</span><span class="s1">'attention_mask'</span><span class="p">]</span> <span class="n">token_type</span> <span class="o">=</span> <span class="n">paraphrase</span><span class="p">[</span><span class="s1">'token_type_ids'</span><span class="p">]</span> <span class="n">paraphrase_len</span> <span class="o">=</span> <span class="n">inputs</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="n">target_bucket</span> <span class="o">=</span> <span class="kc">None</span> <span class="k">for</span> <span class="n">bucket_size</span> <span class="ow">in</span> <span class="n">bucket_sizes</span><span class="p">:</span> <span class="k">if</span> <span class="n">paraphrase_len</span> <span class="o">&lt;=</span> <span class="n">bucket_size</span><span class="p">:</span> <span class="n">target_bucket</span> <span class="o">=</span> <span class="n">bucket_size</span> <span class="k">break</span> <span class="c1"># Pad the paraphrase to match the size of the bucket</span> <span class="n">delta</span> <span class="o">=</span> <span class="n">target_bucket</span> <span class="o">-</span> <span class="n">paraphrase_len</span> <span class="n">zeros</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="n">delta</span><span class="p">],</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">long</span><span class="p">)</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">([</span><span class="n">inputs</span><span class="p">,</span> <span class="n">zeros</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="n">attention</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">([</span><span class="n">attention</span><span class="p">,</span> <span class="n">zeros</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="n">token_type</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">cat</span><span class="p">([</span><span class="n">token_type</span><span class="p">,</span> <span class="n">zeros</span><span class="p">],</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="n">paraphrase_padded</span> <span class="o">=</span> <span class="n">inputs</span><span class="p">,</span> <span class="n">attention</span><span class="p">,</span> <span class="n">token_type</span> <span class="k">return</span> <span class="n">paraphrase_padded</span><span class="p">,</span> <span class="n">target_bucket</span> <span class="c1"># Create two sample sequences</span> <span class="n">sequence_0</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"The only other bear similar in size to the polar bear is the "</span> <span class="s2">"Kodiak bear, which is a subspecies of the brown bear. Adult male "</span> <span class="s2">"polar bears weigh 350–700 kg and measure 2.4–3 meters in total "</span> <span class="s2">"length. All bears are short-tailed, the polar bear's tail is "</span> <span class="s2">"relatively the shortest amongst living bears."</span><span class="p">)</span> <span class="n">sequence_1</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"Around the Beaufort Sea, however, mature males reportedly "</span> <span class="s2">"average 450 kg. Adult females are roughly half the size of males "</span> <span class="s2">"and normally weigh 150–250 kg, measuring 1.8–2.4 meters in length. "</span> <span class="s2">"The legs are stocky and the ears and tail are small."</span><span class="p">)</span> <span class="c1"># Run inference on inputs with different shapes</span> <span class="c1"># We create the variable shapes by randomly cropping the sequences</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">10</span><span class="p">):</span> <span class="c1"># Get random sequence lengths between 0 and 128</span> <span class="n">paraphrase_len</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">128</span><span class="p">))</span> <span class="c1"># Crop the paraphrase</span> <span class="n">paraphrase_cropped</span> <span class="o">=</span> <span class="n">tokenizer</span><span class="o">.</span><span class="n">encode_plus</span><span class="p">(</span><span class="n">sequence_0</span><span class="p">,</span> <span class="n">sequence_1</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="n">paraphrase_len</span><span class="p">,</span> <span class="n">padding</span><span class="o">=</span><span class="s1">'max_length'</span><span class="p">,</span> <span class="n">truncation</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">return_tensors</span><span class="o">=</span><span class="s2">"pt"</span><span class="p">)</span> <span class="c1"># Determine bucket and pad the paraphrase</span> <span class="n">paraphrase_padded</span><span class="p">,</span> <span class="n">target_bucket</span> <span class="o">=</span> <span class="n">get_bucket_and_pad_paraphrase</span><span class="p">(</span><span class="n">paraphrase_cropped</span><span class="p">)</span> <span class="c1"># Use the corresponding bucket to run inference</span> <span class="n">output</span> <span class="o">=</span> <span class="n">buckets</span><span class="p">[</span><span class="n">target_bucket</span><span class="p">](</span><span class="o">*</span><span class="n">paraphrase_padded</span><span class="p">)</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="torch-neuron-dataparallel-app-note.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Data Parallel Inference on Torch Neuron</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:00.020Z
Misc (torch-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/misc-inference-torch-neuron.html
# Misc (torch-neuron) — AWS Neuron Documentation previous PyTorch Neuron (`torch-neuron`) Core Placement
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Misc (torch-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuron) Supported operators" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> <link rel="prev" title="PyTorch Neuron (torch-neuron) Core Placement" href="guides/core-placement/torch-core-placement.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/misc-inference-torch-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/misc-inference-torch-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/misc-inference-torch-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuron/misc-inference-torch-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Misc (torch-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="misc-torch-neuron"> <h1>Misc (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<a class="headerlink" href="#misc-torch-neuron" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a></p></li> <li><p><a class="reference internal" href="troubleshooting-guide.html#pytorch-neuron-inference-troubleshooting"><span class="std std-ref">Troubleshooting Guide for PyTorch Neuron (torch-neuron)</span></a></p></li> <li><p><a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html#pytorch-neuron-rn"><span class="std std-ref">PyTorch Neuron (torch-neuron) release notes</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="guides/core-placement/torch-core-placement.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Core Placement</p> </div> </a> <a class="right-next" id="next-link" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Supported operators</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:01.022Z
PyTorch Neuron (torch-neuron) Core Placement — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html
# PyTorch Neuron (torch-neuron) Core Placement — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## [PyTorch Neuron (`torch-neuron`) Core Placement](#id1)[#](#pytorch-neuron-torch-neuron-core-placement "Permalink to this headline") This programming guide describes the available techniques and APIs to be able to allocate NeuronCores to a process and place models onto specific NeuronCores. In order of precedence, the current recommendation is to use the following placement techniques: 1. For most regular models, default core placement should be used in conjunction with `NEURON_RT_NUM_CORES` ([Default Core Allocation & Placement](#torch-placement-default)) 2. For more specific core placement for NeuronCore Pipelined models, then `NEURONCORE_GROUP_SIZES` should be used ([NEURONCORE\_GROUP\_SIZES](#torch-placement-ncg)). 3. Finally, for even more granular control, then the experimental explicit placement APIs may be used ([Experimental: Explicit Core Placement](#torch-placement-explicit)). Table of Contents - [PyTorch Neuron (`torch-neuron`) Core Placement](#pytorch-neuron-torch-neuron-core-placement) - [NeuronCore Pipeline](#neuroncore-pipeline) - [Default Core Allocation & Placement](#default-core-allocation-placement) - [Example: Default](#example-default) - [Example: `NEURON_RT_NUM_CORES`](#example-neuron-rt-num-cores) - [Example: `NEURON_RT_VISIBLE_CORES`](#example-neuron-rt-visible-cores) - [Example: Overlapping Models](#example-overlapping-models) - [Example: Multiple Processes](#example-multiple-processes) - [NEURONCORE\_GROUP\_SIZES](#neuroncore-group-sizes) - [Example: Single NeuronCore Group](#example-single-neuroncore-group) - [Example: Multiple NeuronCore Groups](#example-multiple-neuroncore-groups) - [Issue: Overlapping Models with Differing Model Sizes](#issue-overlapping-models-with-differing-model-sizes) - [Issue: Incompatible Model Sizes](#issue-incompatible-model-sizes) - [Issue: Multiple Model Copies](#issue-multiple-model-copies) - [Issue Summary](#issue-summary) - [Experimental: Explicit Core Placement](#experimental-explicit-core-placement) - [Example: Manual Core Selection](#example-manual-core-selection) - [Example: Automatic Multicore](#example-automatic-multicore) - [Example: Explicit Replication](#example-explicit-replication) The following guide will assume a machine with 8 NeuronCores: - NeuronCores will use the notation `nc0`, `nc1`, etc. - NeuronCore Groups will use the notation `ncg0`, `ncg1` etc. - Models will use the notation `m0`, `m1` etc. NeuronCores, NeuronCore Groups, and model allocations will be displayed in the following format: NeuronCore Groups Models nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 NeuronCores Note that the actual cores that are visible to the process can be adjusted according to the [Neuron Runtime Configuration](../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration). ## [NeuronCore Pipeline](#id2)[#](#neuroncore-pipeline "Permalink to this headline") A key concept to understand the intent behind certain core placement strategies is NeuronCore Pipelining (See [NeuronCore Pipeline](../../../../../general/arch/neuron-features/neuroncore-pipeline.html#neuroncore-pipeline)). NeuronCore Pipelining allows a model to be automatically split into pieces and executed on different NeuronCores. For most models only 1 NeuronCore will be required for execution. A model will **only** require more than one NeuronCore when using NeuronCore Pipeline. When model pipelining is enabled, the model is split between multiple NeuronCores and data is transferred between them. For example, if the compiler flag `--neuroncore-pipeline-cores 4` is used, this splits the model into 4 pieces to be executed on 4 separate NeuronCores. ## [Default Core Allocation & Placement](#id3)[#](#default-core-allocation-placement "Permalink to this headline") The most basic requirement of an inference application is to be able to place a single model on a single NeuronCore. More complex applications may use multiple NeuronCores or even multiple processes each executing different models. The important thing to note about designing an inference application is that a single NeuronCore will always be allocated to a single process. _Processes do not share NeuronCores_. Different configurations can be used to ensure that an application process has enough NeuronCores allocated to execute its model(s): - Default: A process will attempt to take ownership of **all NeuronCores** visible on the instance. This should be used when an instance is only running a single inference process since no other process will be allowed to take ownership of any NeuronCores. - `NEURON_RT_NUM_CORES`: Specify the **number of NeuronCores** to allocate to the process. This places no restrictions on which NeuronCores will be used, however, the resulting NeuronCores will always be contiguous. This should be used in multi-process applications where each process should only use a subset of NeuronCores. - `NEURON_RT_VISIBLE_CORES`: Specifies exactly **which NeuronCores** are allocated to the process by index. Similar to `NEURON_RT_NUM_CORES`, this can be used in multi-process applications where each process should only use a subset of NeuronCores. This provides more fined-grained controls over the exact NeuronCores that are allocated to a given process. - `NEURONCORE_GROUP_SIZES`: Specifies a number of **NeuronCore Groups** which are allocated to the process. This is described in more detail in the [NEURONCORE\_GROUP\_SIZES](#torch-placement-ncg) section. See the [Neuron Runtime Configuration](../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration) for more environment variable details. ### [Example: Default](#id4)[#](#example-default "Permalink to this headline") **Python Script**: ``` import torch import torch_neuron m0 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc0 m1 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc1 ``` allocated m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 With no environment configuration, the process will take ownership of all NeuronCores. In this example, only two of the NeuronCores are used by the process and the remaining are allocated but left idle. ### [Example: `NEURON_RT_NUM_CORES`](#id5)[#](#example-neuron-rt-num-cores "Permalink to this headline") **Environment Setup**: ``` export NEURON_RT_NUM_CORES = '2' ``` **Python Script**: ``` import torch import torch_neuron m0 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc0 m1 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc1 ``` allocated unallocated m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 Since there is no other process on the instance, only the first 2 NeuronCores will be acquired by the process. Models load in a simple linear order to the least used NeuronCores. ### [Example: `NEURON_RT_VISIBLE_CORES`](#id6)[#](#example-neuron-rt-visible-cores "Permalink to this headline") **Environment Setup**: ``` export NEURON_RT_VISIBLE_CORES = '4-5' ``` **Python Script**: ``` import torch import torch_neuron m0 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc4 m1 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc5 ``` allocated unallocated unallocated m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 Unlike `NEURON_RT_NUM_CORES`, setting the visible NeuronCores allows the process to take control of a specific contiguous set. This allows an application to have a more fine-grained control of where models will be placed. ### [Example: Overlapping Models](#id7)[#](#example-overlapping-models "Permalink to this headline") **Environment Setup**: ``` export NEURON_RT_VISIBLE_CORES = '0-1' ``` **Python Script**: ``` import torch import torch_neuron m0 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc0 m1 = torch.jit.load('model-with-2-neuron-pipeline-cores.pt') # Loads to nc0-nc1 m2 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc1 ``` m1 allocated unallocated m0 m2 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 This shows how models may share NeuronCores but the default model placement will attempt to evenly distribute NeuronCore usage rather than overlapping all models on a single NeuronCore. ### [Example: Multiple Processes](#id8)[#](#example-multiple-processes "Permalink to this headline") **Environment Setup**: ``` export NEURON_RT_NUM_CORES = '2' ``` **Python Script**: ``` import torch import torch_neuron m0 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc0 m1 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc1 ``` In this example, if the script is run **twice**, the following allocations will be made: proc0 proc1 unallocated m0 m1 m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 Note that each process will take ownership of as many NeuronCores as is specified by the `NEURON_RT_NUM_CORES` configuration. ## [NEURONCORE\_GROUP\_SIZES](#id9)[#](#neuroncore-group-sizes "Permalink to this headline") Important The use of explicit core placement should only be used when a specific performance goal is required. By default `torch-neuron` places models on the **least used** NeuronCores. This should be optimal for most applications. Secondly, `NEURONCORE_GROUP_SIZES` is being deprecated in a future release and should be avoided in favor of newer placement methods. Use `NEURON_RT_NUM_CORES` or `NEURON_RT_VISIBLE_CORES` with default placement if possible (See [Default Core Allocation & Placement](#torch-placement-default)) In the current release of NeuronSDK, the most well-supported method of placing models onto specific NeuronCores is to use the `NEURONCORE_GROUP_SIZES` environment variable. This will define a set of “NeuronCore Groups” for the application process. NeuronCore Groups are _contiguous sets of NeuronCores_ that are allocated to a given process. Creating groups allows an application to ensure that a model has a defined set of NeuronCores that will always be allocated to it. Note that NeuronCore Groups _can_ be used to allocate non-pipelined models (those requiring exactly 1 NeuronCore) to specific NeuronCores but this is not the primary intended use. The intended use of NeuronCore Groups is to ensure pipelined models (those requiring >1 NeuronCore) have exclusive access to a specific set of contiguous NeuronCores. In the cases where models are being used _without_ NeuronCore Pipeline, the general recommendation is to use default placement (See [Default Core Allocation & Placement](#torch-placement-default)). The following section demonstrates how `NEURONCORE_GROUP_SIZES` can be used and the issues that may arise. ### [Example: Single NeuronCore Group](#id10)[#](#example-single-neuroncore-group "Permalink to this headline") In the example where one model requires 4 NeuronCores, the correct environment configuration would be: **Environment Setup**: ``` export NEURONCORE_GROUP_SIZES = '4' ``` **Python Script**: ``` import torch import torch_neuron m0 = torch.jit.load('model-with-4-neuron-pipeline-cores.pt') # Loads to nc0-nc3 ``` ncg0 unallocated m0 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 This is the most basic usage of a NeuronCore Group. The environment setup causes the process to take control of 4 NeuronCores and then the script loads a model compiled with a NeuronCore Pipeline size of 4 to the first group. ### [Example: Multiple NeuronCore Groups](#id11)[#](#example-multiple-neuroncore-groups "Permalink to this headline") With more complicated configurations, the intended use of `NEURONCORE_GROUP_SIZES` is to create 1 Group per model with the correct size to ensure that the models are placed on the intended NeuronCores. Similarly, the environment would need to be configured to create a NeuronCore Group for each model: **Environment Setup**: ``` export NEURONCORE_GROUP_SIZES = '3,4,1' ``` **Python Script**: ``` import torch import torch_neuron m0 = torch.jit.load('model-with-3-neuron-pipeline-cores.pt') # Loads to nc0-nc2 m1 = torch.jit.load('model-with-4-neuron-pipeline-cores.pt') # Loads to nc3-nc6 m2 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc7 ``` ncg0 ncg1 ncg2 m0 m1 m2 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 ### [Issue: Overlapping Models with Differing Model Sizes](#id12)[#](#issue-overlapping-models-with-differing-model-sizes "Permalink to this headline") When multiple models are loaded to a single NeuronCore Group, this can cause unintended inefficiencies. A single model is only intended to span a single NeuronCore Group. Applications with many models of varying sizes can be restricted by NeuronCore Group configurations since the most optimal model layout may require more fine-grained controls. **Environment Setup**: ``` export NEURONCORE_GROUP_SIZES = '2,2' ``` **Python Script**: ``` import torch import torch_neuron m0 = torch.jit.load('model-with-2-neuron-pipeline-cores.pt') # Loads to nc0-nc1 m1 = torch.jit.load('model-with-2-neuron-pipeline-cores.pt') # Loads to nc2-nc3 m2 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc0 m3 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc2 m4 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc0 ``` m4 m2 m3 ncg0 ncg1 unallocated m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 Here the `NEURONCORE_GROUP_SIZES` does not generate an optimal layout because placement strictly follows the layout of NeuronCore Groups. A potentially more optimal layout would be to place `m4` onto `nc1`. In this case, since a pipelined model will not be able to have exclusive access to a set of NeuronCores, the default NeuronCore placement (no NeuronCore Groups specified) would more evenly distribute the models. Also note here that this is an example of where the order of model loads affects which model is assigned to which NeuronCore Group. If the order of the load statements is changed, models may be assigned to different NeuronCore Groups. ### [Issue: Incompatible Model Sizes](#id13)[#](#issue-incompatible-model-sizes "Permalink to this headline") Another problem occurs when attempting to place a model which does not evenly fit into a single group: **Environment Setup**: ``` export NEURONCORE_GROUP_SIZES = '2,2' ``` **Python Script**: ``` import torch import torch_neuron m0 = torch.jit.load('model-with-2-neuron-pipeline-cores.pt') # Loads to nc0-nc1 m1 = torch.jit.load('model-with-2-neuron-pipeline-cores.pt') # Loads to nc2-nc3 m2 = torch.jit.load('model-with-3-neuron-pipeline-cores.pt') # Loads to nc0-nc2 ``` m2 ncg0 ncg1 unallocated m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 The model will be placed _across_ NeuronCore Groups since there is no obvious group to assign the model to according to the environment variable configuration. Depending on the individual model and application requirements, the placement here may not be optimal. ### [Issue: Multiple Model Copies](#id14)[#](#issue-multiple-model-copies "Permalink to this headline") It is common in inference serving applications to use multiple replicas of a single model across different NeuronCores. This allows the hardware to be fully utilized to maximize throughput. In this scenario, when using NeuronCore Groups, the only way to replicate a model on multiple NeuronCores is to create a _new model_ object. In the example below, 4 models loads are performed to place a model in each NeuronCore Group. **Environment Setup**: ``` export NEURONCORE_GROUP_SIZES = '2,2,2,2' ``` **Python Script**: ``` import torch import torch_neuron models = list() for _ in range(4): model = torch.jit.load('model-with-2-neuron-pipeline-cores.pt') models.append(model) ``` ncg0 ncg1 ncg2 ncg3 models\[0\] models\[1\] models\[2\] models\[3\] nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 The largest consequence of this type of model allocation is that the application code is responsible for routing inference requests to models. There are a variety of ways to implement the inference switching but in all cases routing logic needs to be implemented in the application code. ### [Issue Summary](#id15)[#](#issue-summary "Permalink to this headline") The use of `NEURONCORE_GROUP_SIZES` has the following problems: - **Variable Sized Models**: Models which require crossing NeuronCore Group boundaries may be placed poorly. This means group configuration limits the size of which models can be loaded. - **Model Load Order**: Models are loaded to NeuronCore Groups greedily. This means that the order of model loads can potentially negatively affect application performance by causing unintentional overlap. - **Implicit Placement**: NeuronCore Groups cannot be explicitly chosen in the application code. - **Manual Replication**: When loading multiple copies of a model to different NeuronCore Groups, this requires that multiple model handles are used. ## [Experimental: Explicit Core Placement](#id16)[#](#experimental-explicit-core-placement "Permalink to this headline") To address the limitations of `NEURONCORE_GROUP_SIZES`, a new set of APIs has been added which allows specific NeuronCores to be chosen by the application code. These can be found in the torch\_neuron\_core\_placement\_api documentation. ### [Example: Manual Core Selection](#id17)[#](#example-manual-core-selection "Permalink to this headline") The most direct usage of the placement APIs is to manually select the start NeuronCore that each model is loaded to. This will automatically use as many NeuronCores as is necessary for that model (1 for most models, >1 for NeuronCore Pipelines models). **Environment Setup**: ``` export NEURON_RT_NUM_CORES = '4' ``` **Python Script**: ``` import torch import torch_neuron # NOTE: Order of loads does NOT matter with torch_neuron.experimental.neuron_cores_context(2): m1 = torch.jit.load('model-with-2-neuron-pipeline-cores.pt') # Loads to nc2-nc3 with torch_neuron.experimental.neuron_cores_context(0): m2 = torch.jit.load('model-with-3-neuron-pipeline-cores.pt') # Loads to nc0-nc2 with torch_neuron.experimental.neuron_cores_context(0): m0 = torch.jit.load('model-with-2-neuron-pipeline-cores.pt') # Loads to nc0-nc1 with torch_neuron.experimental.neuron_cores_context(3): m3 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads to nc3 ``` m2 m3 allocated unallocated m0 m1 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 Note that this directly solves the `NEURONCORE_GROUP_SIZES` issues of: - **Variable Sized Models**: Now since models are directly placed on the NeuronCores requested by the application, there is no disconnect between the model sizes and NeuronCore Group sizes. - **Model Load Order**: Since the NeuronCores are explicitly selected, there is no need to be careful about the order in which models are loaded since they can be placed deterministically regardless of the load order. - **Implicit Placement**: Similarly, explicit placement means there is no chance that a model will end up being allocated to an incorrect NeuronCore Group. ### [Example: Automatic Multicore](#id18)[#](#example-automatic-multicore "Permalink to this headline") Using explicit core placement it is possible to replicate a model to multiple NeuronCores simultaneously. This means that a single model object within python can utilize all available NeuronCores (or NeuronCores allocated to the process). **Environment Setup**: ``` export NEURON_RT_NUM_CORES = '8' ``` **Python Script**: ``` import torch import torch_neuron with torch_neuron.experimental.multicore_context(): m0 = torch.jit.load('model-with-1-neuron-pipeline-cores.pt') # Loads replications to nc0-nc7 ``` allocated m0 m0 m0 m0 m0 m0 m0 m0 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 This addresses the last `NEURONCORE_GROUP_SIZES` issue of: - **Manual Replication**: Since models can be automatically replicated to multiple NeuronCores, this means that applications no longer need to implement routing logic and perform multiple loads. This API has a secondary benefit that the exact same loading logic can be used on an `inf1.xlarge` or an `inf1.6xlarge`. In either case, it will use all of the NeuronCores that are visible to the process. This means that no special logic needs to be coded for different instance types. ### [Example: Explicit Replication](#id19)[#](#example-explicit-replication "Permalink to this headline") Replication is also possible with the `neuron_cores_context()` API. The number of replications is chosen by `replications = floor(nc_count / cores_per_model)`. **Environment Setup**: ``` export NEURON_RT_NUM_CORES = '8' ``` **Python Script**: ``` import torch import torch_neuron with torch_neuron.experimental.neuron_cores_context(start_nc=2, nc_count=4): m0 = torch.jit.load('model-with-2-neuron-pipeline-cores.pt') # Loads replications to nc2-nc5 ``` allocated m0 m0 nc0 nc1 nc2 nc3 nc4 nc5 nc6 nc7 _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuron) Core Placement — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Misc (torch-neuron)" href="../../misc-inference-torch-neuron.html"> <link rel="prev" title="Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support" href="../torch-lstm-support.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../developer-guide-torch-neuron.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-pipeline"> NeuronCore Pipeline </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-core-allocation-placement"> Default Core Allocation &amp; Placement </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-default"> Example: Default </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-neuron-rt-num-cores"> Example: <code class="docutils literal notranslate"> <span class="pre"> NEURON_RT_NUM_CORES </span> </code> </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-neuron-rt-visible-cores"> Example: <code class="docutils literal notranslate"> <span class="pre"> NEURON_RT_VISIBLE_CORES </span> </code> </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-overlapping-models"> Example: Overlapping Models </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-multiple-processes"> Example: Multiple Processes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-group-sizes"> NEURONCORE_GROUP_SIZES </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-single-neuroncore-group"> Example: Single NeuronCore Group </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-multiple-neuroncore-groups"> Example: Multiple NeuronCore Groups </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#issue-overlapping-models-with-differing-model-sizes"> Issue: Overlapping Models with Differing Model Sizes </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#issue-incompatible-model-sizes"> Issue: Incompatible Model Sizes </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#issue-multiple-model-copies"> Issue: Multiple Model Copies </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#issue-summary"> Issue Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#experimental-explicit-core-placement"> Experimental: Explicit Core Placement </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-manual-core-selection"> Example: Manual Core Selection </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-automatic-multicore"> Example: Automatic Multicore </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-explicit-replication"> Example: Explicit Replication </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuron) Core Placement</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-pipeline"> NeuronCore Pipeline </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-core-allocation-placement"> Default Core Allocation &amp; Placement </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-default"> Example: Default </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-neuron-rt-num-cores"> Example: <code class="docutils literal notranslate"> <span class="pre"> NEURON_RT_NUM_CORES </span> </code> </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-neuron-rt-visible-cores"> Example: <code class="docutils literal notranslate"> <span class="pre"> NEURON_RT_VISIBLE_CORES </span> </code> </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-overlapping-models"> Example: Overlapping Models </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-multiple-processes"> Example: Multiple Processes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-group-sizes"> NEURONCORE_GROUP_SIZES </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-single-neuroncore-group"> Example: Single NeuronCore Group </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-multiple-neuroncore-groups"> Example: Multiple NeuronCore Groups </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#issue-overlapping-models-with-differing-model-sizes"> Issue: Overlapping Models with Differing Model Sizes </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#issue-incompatible-model-sizes"> Issue: Incompatible Model Sizes </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#issue-multiple-model-copies"> Issue: Multiple Model Copies </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#issue-summary"> Issue Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#experimental-explicit-core-placement"> Experimental: Explicit Core Placement </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-manual-core-selection"> Example: Manual Core Selection </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-automatic-multicore"> Example: Automatic Multicore </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-explicit-replication"> Example: Explicit Replication </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="pytorch-neuron-torch-neuron-core-placement"> <span id="torch-neuron-core-placement-guide"></span><h1><a class="toc-backref" href="#id1">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Core Placement</a><a class="headerlink" href="#pytorch-neuron-torch-neuron-core-placement" title="Permalink to this headline">#</a></h1> <p>This programming guide describes the available techniques and APIs to be able to allocate NeuronCores to a process and place models onto specific NeuronCores. In order of precedence, the current recommendation is to use the following placement techniques:</p> <ol class="arabic simple"> <li><p>For most regular models, default core placement should be used in conjunction with <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code> (<a class="reference internal" href="#torch-placement-default"><span class="std std-ref">Default Core Allocation &amp; Placement</span></a>)</p></li> <li><p>For more specific core placement for NeuronCore Pipelined models, then <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> should be used (<a class="reference internal" href="#torch-placement-ncg"><span class="std std-ref">NEURONCORE_GROUP_SIZES</span></a>).</p></li> <li><p>Finally, for even more granular control, then the experimental explicit placement APIs may be used (<a class="reference internal" href="#torch-placement-explicit"><span class="std std-ref">Experimental: Explicit Core Placement</span></a>).</p></li> </ol> <div class="contents topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#pytorch-neuron-torch-neuron-core-placement" id="id1">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Core Placement</a></p> <ul> <li><p><a class="reference internal" href="#neuroncore-pipeline" id="id2">NeuronCore Pipeline</a></p></li> <li><p><a class="reference internal" href="#default-core-allocation-placement" id="id3">Default Core Allocation &amp; Placement</a></p> <ul> <li><p><a class="reference internal" href="#example-default" id="id4">Example: Default</a></p></li> <li><p><a class="reference internal" href="#example-neuron-rt-num-cores" id="id5">Example: <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code></a></p></li> <li><p><a class="reference internal" href="#example-neuron-rt-visible-cores" id="id6">Example: <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code></a></p></li> <li><p><a class="reference internal" href="#example-overlapping-models" id="id7">Example: Overlapping Models</a></p></li> <li><p><a class="reference internal" href="#example-multiple-processes" id="id8">Example: Multiple Processes</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#neuroncore-group-sizes" id="id9">NEURONCORE_GROUP_SIZES</a></p> <ul> <li><p><a class="reference internal" href="#example-single-neuroncore-group" id="id10">Example: Single NeuronCore Group</a></p></li> <li><p><a class="reference internal" href="#example-multiple-neuroncore-groups" id="id11">Example: Multiple NeuronCore Groups</a></p></li> <li><p><a class="reference internal" href="#issue-overlapping-models-with-differing-model-sizes" id="id12">Issue: Overlapping Models with Differing Model Sizes</a></p></li> <li><p><a class="reference internal" href="#issue-incompatible-model-sizes" id="id13">Issue: Incompatible Model Sizes</a></p></li> <li><p><a class="reference internal" href="#issue-multiple-model-copies" id="id14">Issue: Multiple Model Copies</a></p></li> <li><p><a class="reference internal" href="#issue-summary" id="id15">Issue Summary</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#experimental-explicit-core-placement" id="id16">Experimental: Explicit Core Placement</a></p> <ul> <li><p><a class="reference internal" href="#example-manual-core-selection" id="id17">Example: Manual Core Selection</a></p></li> <li><p><a class="reference internal" href="#example-automatic-multicore" id="id18">Example: Automatic Multicore</a></p></li> <li><p><a class="reference internal" href="#example-explicit-replication" id="id19">Example: Explicit Replication</a></p></li> </ul> </li> </ul> </li> </ul> </div> <p>The following guide will assume a machine with 8 NeuronCores:</p> <ul class="simple"> <li><p>NeuronCores will use the notation <code class="docutils literal notranslate"><span class="pre">nc0</span></code>, <code class="docutils literal notranslate"><span class="pre">nc1</span></code>, etc.</p></li> <li><p>NeuronCore Groups will use the notation <code class="docutils literal notranslate"><span class="pre">ncg0</span></code>, <code class="docutils literal notranslate"><span class="pre">ncg1</span></code> etc.</p></li> <li><p>Models will use the notation <code class="docutils literal notranslate"><span class="pre">m0</span></code>, <code class="docutils literal notranslate"><span class="pre">m1</span></code> etc.</p></li> </ul> <p>NeuronCores, NeuronCore Groups, and model allocations will be displayed in the following format:</p> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="1px" y="68%" height="31%" width="97.5%" rx="5" opacity="100%" fill="none" stroke="black" stroke-width="1px" stroke-dasharray="6"> <animate attributeName="stroke-dashoffset" values="12px;0px" dur="0.2s" calcMode="linear" repeatCount="indefinite"></animate> </rect> <text x="50%" y="82.5%" class="label" style="fill:black">NeuronCore Groups</text> <!-- Models --> <rect x="1px" y="1px" height="31%" width="97.5%" rx="5" opacity="100%" fill="None" stroke="black" stroke-width="1px" stroke-dasharray="6"> <animate attributeName="stroke-dashoffset" values="12px;0px" dur="0.2s" calcMode="linear" repeatCount="indefinite"></animate> </rect> <text x="50.0%" y="16.66%" class="label" style="fill:black">Models</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> <linearGradient id="lgrad" x1="100%" y1="50%" x2="0%" y2="50%"> <stop offset="0" stop-color="white"></stop> <stop offset="0.3" stop-color="black"></stop> <stop offset="0.7" stop-color="black"></stop> <stop offset="1" stop-color="white"></stop> </linearGradient> <mask id="myMask" x="0" y="0" width="100%" height="100%"> <rect x="0" y="0" width="100%" height="100%" fill="url(#lgrad)"></rect> </mask> </defs> <g mask="url(#myMask)"> <g fill="gray"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </g> <text x="50%" y="50%" class="label" style="fill:black">NeuronCores</text> </svg> <p>Note that the actual cores that are visible to the process can be adjusted according to the <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration"><span class="std std-ref">Neuron Runtime Configuration</span></a>.</p> <div class="section" id="neuroncore-pipeline"> <h2><a class="toc-backref" href="#id2">NeuronCore Pipeline</a><a class="headerlink" href="#neuroncore-pipeline" title="Permalink to this headline">#</a></h2> <p>A key concept to understand the intent behind certain core placement strategies is NeuronCore Pipelining (See <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html#neuroncore-pipeline"><span class="std std-ref">NeuronCore Pipeline</span></a>). NeuronCore Pipelining allows a model to be automatically split into pieces and executed on different NeuronCores.</p> <p>For most models only 1 NeuronCore will be required for execution. A model will <strong>only</strong> require more than one NeuronCore when using NeuronCore Pipeline. When model pipelining is enabled, the model is split between multiple NeuronCores and data is transferred between them. For example, if the compiler flag <code class="docutils literal notranslate"><span class="pre">--neuroncore-pipeline-cores</span> <span class="pre">4</span></code> is used, this splits the model into 4 pieces to be executed on 4 separate NeuronCores.</p> </div> <div class="section" id="default-core-allocation-placement"> <span id="torch-placement-default"></span><h2><a class="toc-backref" href="#id3">Default Core Allocation &amp; Placement</a><a class="headerlink" href="#default-core-allocation-placement" title="Permalink to this headline">#</a></h2> <p>The most basic requirement of an inference application is to be able to place a single model on a single NeuronCore. More complex applications may use multiple NeuronCores or even multiple processes each executing different models. The important thing to note about designing an inference application is that a single NeuronCore will always be allocated to a single process. <em>Processes do not share NeuronCores</em>. Different configurations can be used to ensure that an application process has enough NeuronCores allocated to execute its model(s):</p> <ul class="simple"> <li><p>Default: A process will attempt to take ownership of <strong>all NeuronCores</strong> visible on the instance. This should be used when an instance is only running a single inference process since no other process will be allowed to take ownership of any NeuronCores.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code>: Specify the <strong>number of NeuronCores</strong> to allocate to the process. This places no restrictions on which NeuronCores will be used, however, the resulting NeuronCores will always be contiguous. This should be used in multi-process applications where each process should only use a subset of NeuronCores.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code>: Specifies exactly <strong>which NeuronCores</strong> are allocated to the process by index. Similar to <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code>, this can be used in multi-process applications where each process should only use a subset of NeuronCores. This provides more fined-grained controls over the exact NeuronCores that are allocated to a given process.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code>: Specifies a number of <strong>NeuronCore Groups</strong> which are allocated to the process. This is described in more detail in the <a class="reference internal" href="#torch-placement-ncg"><span class="std std-ref">NEURONCORE_GROUP_SIZES</span></a> section.</p></li> </ul> <p>See the <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html#nrt-configuration"><span class="std std-ref">Neuron Runtime Configuration</span></a> for more environment variable details.</p> <div class="section" id="example-default"> <h3><a class="toc-backref" href="#id4">Example: Default</a><a class="headerlink" href="#example-default" title="Permalink to this headline">#</a></h3> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc1</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="97.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="50%" y="82.5%" class="label" style="fill:black">allocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" width="10%" height="31%" rx="20"></rect> <rect x="12.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>With no environment configuration, the process will take ownership of all NeuronCores. In this example, only two of the NeuronCores are used by the process and the remaining are allocated but left idle.</p> </div> <div class="section" id="example-neuron-rt-num-cores"> <h3><a class="toc-backref" href="#id5">Example: <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code></a><a class="headerlink" href="#example-neuron-rt-num-cores" title="Permalink to this headline">#</a></h3> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_NUM_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'2'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc1</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } .small { font-family: Consolas, monaco, monospace; font-size: 1.5vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="11.25%" y="82.5%" class="small" style="fill:black">allocated</text> <rect x="25.0%" y="33%" height="66.6%" width="75%" rx="20" opacity="20%" fill="gray"></rect> <text x="61.5%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" width="10%" height="31%" rx="20"></rect> <rect x="12.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> </g> <g fill="gray"> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>Since there is no other process on the instance, only the first 2 NeuronCores will be acquired by the process. Models load in a simple linear order to the least used NeuronCores.</p> </div> <div class="section" id="example-neuron-rt-visible-cores"> <h3><a class="toc-backref" href="#id6">Example: <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code></a><a class="headerlink" href="#example-neuron-rt-visible-cores" title="Permalink to this headline">#</a></h3> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_VISIBLE_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'4-5'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc4</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc5</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } .small { font-family: Consolas, monaco, monospace; font-size: 1.5vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="50%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="61.25%" y="82.5%" class="small" style="fill:black">allocated</text> <rect x="0.0%" y="33%" height="66.6%" width="47.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="23.75%" y="82.5%" class="label" style="fill:black">unallocated</text> <rect x="75%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="86.25%" y="82.5%" class="label" style="fill:black;font-size: 1.5vw">unallocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="50.0%" width="10%" height="31%" rx="20"></rect> <rect x="62.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="55.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="67.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> </g> <g fill="gray"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>Unlike <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code>, setting the visible NeuronCores allows the process to take control of a specific contiguous set. This allows an application to have a more fine-grained control of where models will be placed.</p> </div> <div class="section" id="example-overlapping-models"> <h3><a class="toc-backref" href="#id7">Example: Overlapping Models</a><a class="headerlink" href="#example-overlapping-models" title="Permalink to this headline">#</a></h3> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_VISIBLE_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'0-1'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-2-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0-nc1</span> <span class="n">m2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc1</span> </pre></div> </div> <svg width="100%" height="50px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" height="100%" width="22.5%" rx="20"> <animate attributeName="opacity" values="1;0;0;1;1;1" dur="5s" repeatCount="indefinite"></animate> </rect> </g> <text x="11.5%" y="50%" class="label" style="fill:black">m1 <animate attributeName="opacity" values="1;0;0;1;1;1" dur="5s" repeatCount="indefinite"></animate> </text> </svg><svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } .small { font-family: Consolas, monaco, monospace; font-size: 1.5vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="11.25%" y="82.5%" class="small" style="fill:black">allocated</text> <rect x="25.0%" y="33%" height="66.6%" width="75%" rx="20" opacity="20%" fill="gray"></rect> <text x="61.5%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" width="10%" height="31%" rx="20"> <animate attributeName="opacity" values="1;0;1;1;1;1" dur="5s" repeatCount="indefinite"></animate> </rect> <rect x="12.5%" width="10%" height="31%" rx="20"> <animate attributeName="opacity" values="1;0;0;0;1;1" dur="5s" repeatCount="indefinite"></animate> </rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m0 <animate attributeName="opacity" values="1;0;1;1;1;1" dur="5s" repeatCount="indefinite"></animate> </text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m2 <animate attributeName="opacity" values="1;0;0;0;1;1" dur="5s" repeatCount="indefinite"></animate> </text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> </g> <g fill="gray"> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>This shows how models may share NeuronCores but the default model placement will attempt to evenly distribute NeuronCore usage rather than overlapping all models on a single NeuronCore.</p> </div> <div class="section" id="example-multiple-processes"> <h3><a class="toc-backref" href="#id8">Example: Multiple Processes</a><a class="headerlink" href="#example-multiple-processes" title="Permalink to this headline">#</a></h3> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_NUM_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'2'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc1</span> </pre></div> </div> <p>In this example, if the script is run <strong>twice</strong>, the following allocations will be made:</p> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33.0%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="11.5%" y="82.5%" class="label" style="fill:black">proc0</text> <rect x="25.0%" y="33.0%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="violet"></rect> <text x="36.5%" y="82.5%" class="label" style="fill:black">proc1</text> <rect x="50.0%" y="33.3%" height="66.6%" width="47.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="74.0%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" width="10%" height="31%" rx="20"></rect> <rect x="12.5%" width="10%" height="31%" rx="20"></rect> <rect x="25.0%" width="10%" height="31%" rx="20"></rect> <rect x="37.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m1</text> <text x="30.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="42.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> </g> <g fill="violet"> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> </g> <g fill="gray"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>Note that each process will take ownership of as many NeuronCores as is specified by the <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code> configuration.</p> </div> </div> <div class="section" id="neuroncore-group-sizes"> <span id="torch-placement-ncg"></span><h2><a class="toc-backref" href="#id9">NEURONCORE_GROUP_SIZES</a><a class="headerlink" href="#neuroncore-group-sizes" title="Permalink to this headline">#</a></h2> <div class="admonition important"> <p class="admonition-title">Important</p> <p>The use of explicit core placement should only be used when a specific performance goal is required. By default <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> places models on the <strong>least used</strong> NeuronCores. This should be optimal for most applications.</p> <p>Secondly, <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> is being deprecated in a future release and should be avoided in favor of newer placement methods. Use <code class="docutils literal notranslate"><span class="pre">NEURON_RT_NUM_CORES</span></code> or <code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code> with default placement if possible (See <a class="reference internal" href="#torch-placement-default"><span class="std std-ref">Default Core Allocation &amp; Placement</span></a>)</p> </div> <p>In the current release of NeuronSDK, the most well-supported method of placing models onto specific NeuronCores is to use the <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> environment variable. This will define a set of “NeuronCore Groups” for the application process.</p> <p>NeuronCore Groups are <em>contiguous sets of NeuronCores</em> that are allocated to a given process. Creating groups allows an application to ensure that a model has a defined set of NeuronCores that will always be allocated to it.</p> <p>Note that NeuronCore Groups <em>can</em> be used to allocate non-pipelined models (those requiring exactly 1 NeuronCore) to specific NeuronCores but this is not the primary intended use. The intended use of NeuronCore Groups is to ensure pipelined models (those requiring &gt;1 NeuronCore) have exclusive access to a specific set of contiguous NeuronCores.</p> <p>In the cases where models are being used <em>without</em> NeuronCore Pipeline, the general recommendation is to use default placement (See <a class="reference internal" href="#torch-placement-default"><span class="std std-ref">Default Core Allocation &amp; Placement</span></a>).</p> <p>The following section demonstrates how <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> can be used and the issues that may arise.</p> <div class="section" id="example-single-neuroncore-group"> <h3><a class="toc-backref" href="#id10">Example: Single NeuronCore Group</a><a class="headerlink" href="#example-single-neuroncore-group" title="Permalink to this headline">#</a></h3> <p>In the example where one model requires 4 NeuronCores, the correct environment configuration would be:</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURONCORE_GROUP_SIZES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'4'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-4-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0-nc3</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33.3%" height="66.6%" width="47.5%" rx="20" opacity="40%" fill="dodgerblue"></rect> <text x="24.0%" y="82.5%" class="label" style="fill:black">ncg0</text> <rect x="50.0%" y="33.3%" height="66.6%" width="47.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="74.0%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <rect x="00.0%" height="31%" width="47.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="24.0%" y="16.66%" class="label" style="fill:black">m0</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="blue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> </g> <g fill="gray"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg> <p>This is the most basic usage of a NeuronCore Group. The environment setup causes the process to take control of 4 NeuronCores and then the script loads a model compiled with a NeuronCore Pipeline size of 4 to the first group.</p> </div> <div class="section" id="example-multiple-neuroncore-groups"> <h3><a class="toc-backref" href="#id11">Example: Multiple NeuronCore Groups</a><a class="headerlink" href="#example-multiple-neuroncore-groups" title="Permalink to this headline">#</a></h3> <p>With more complicated configurations, the intended use of <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> is to create 1 Group per model with the correct size to ensure that the models are placed on the intended NeuronCores. Similarly, the environment would need to be configured to create a NeuronCore Group for each model:</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURONCORE_GROUP_SIZES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'3,4,1'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-3-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0-nc2</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-4-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc3-nc6</span> <span class="n">m2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc7</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="35.0%" rx="20" opacity="40%" fill="dodgerblue"></rect> <text x="17.5%" y="82.5%" class="label" style="fill:black">ncg0</text> <rect x="37.5%" y="33%" height="66.6%" width="47.5%" rx="20" opacity="40%" fill="limegreen"></rect> <text x="61.5%" y="82.5%" class="label" style="fill:black">ncg1</text> <rect x="87.5%" y="33%" height="66.6%" width="10.0%" rx="20" opacity="40%" fill="coral"></rect> <text x="92.5%" y="82.5%" class="label" style="fill:black">ncg2</text> <!-- Models --> <rect x="00.0%" height="31%" width="35.0%" rx="20" opacity="40%" fill="orange"></rect> <text x="17.5%" y="16.66%" class="label" style="fill:black">m0</text> <rect x="37.5%" height="31%" width="47.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="61.5%" y="16.66%" class="label" style="fill:black">m1</text> <rect x="87.5%" height="31%" width="10.0%" rx="20" opacity="40%" fill="orange"></rect> <text x="92.5%" y="16.66%" class="label" style="fill:black">m2</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="blue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> </g> <g fill="green"> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> </g> <g fill="red"> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg></div> <div class="section" id="issue-overlapping-models-with-differing-model-sizes"> <h3><a class="toc-backref" href="#id12">Issue: Overlapping Models with Differing Model Sizes</a><a class="headerlink" href="#issue-overlapping-models-with-differing-model-sizes" title="Permalink to this headline">#</a></h3> <p>When multiple models are loaded to a single NeuronCore Group, this can cause unintended inefficiencies. A single model is only intended to span a single NeuronCore Group. Applications with many models of varying sizes can be restricted by NeuronCore Group configurations since the most optimal model layout may require more fine-grained controls.</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURONCORE_GROUP_SIZES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'2,2'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-2-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0-nc1</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-2-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc2-nc3</span> <span class="n">m2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0</span> <span class="n">m3</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc2</span> <span class="n">m4</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0</span> </pre></div> </div> <svg width="100%" height="50px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Models --> <rect x="0px" y="0px" height="100%" width="10.0%" rx="20" opacity="40%" fill="orange"> <animate attributeName="fill" values="red;orange;red" dur="2s" repeatCount="indefinite"></animate> </rect> <text x="5.0%" y="50%" class="label" style="fill:black">m4</text> </svg><svg width="100%" height="50px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Models --> <rect x="00.0%" height="100%" width="10.0%" rx="20" opacity="40%" fill="orange"></rect> <text x="5.0%" y="50%" class="label" style="fill:black">m2</text> <rect x="25.0%" height="100%" width="10.0%" rx="20" opacity="40%" fill="orange"></rect> <text x="30.0%" y="50%" class="label" style="fill:black">m3</text> </svg><svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="dodgerblue"></rect> <text x="11.5%" y="82.5%" class="label" style="fill:black">ncg0</text> <rect x="25.0%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="limegreen"></rect> <text x="36.5%" y="82.5%" class="label" style="fill:black">ncg1</text> <rect x="50.0%" y="33%" height="66.6%" width="47.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="74.0%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <rect x="00.0%" height="31%" width="22.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="11.5%" y="16.66%" class="label" style="fill:black">m0</text> <rect x="25.0%" height="31%" width="22.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="36.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="blue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> </g> <g fill="green"> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> </g> <g fill="gray"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>Here the <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> does not generate an optimal layout because placement strictly follows the layout of NeuronCore Groups. A potentially more optimal layout would be to place <code class="docutils literal notranslate"><span class="pre">m4</span></code> onto <code class="docutils literal notranslate"><span class="pre">nc1</span></code>. In this case, since a pipelined model will not be able to have exclusive access to a set of NeuronCores, the default NeuronCore placement (no NeuronCore Groups specified) would more evenly distribute the models.</p> <p>Also note here that this is an example of where the order of model loads affects which model is assigned to which NeuronCore Group. If the order of the load statements is changed, models may be assigned to different NeuronCore Groups.</p> </div> <div class="section" id="issue-incompatible-model-sizes"> <h3><a class="toc-backref" href="#id13">Issue: Incompatible Model Sizes</a><a class="headerlink" href="#issue-incompatible-model-sizes" title="Permalink to this headline">#</a></h3> <p>Another problem occurs when attempting to place a model which does not evenly fit into a single group:</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURONCORE_GROUP_SIZES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'2,2'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-2-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0-nc1</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-2-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc2-nc3</span> <span class="n">m2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-3-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0-nc2</span> </pre></div> </div> <svg width="100%" height="50px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Models --> <rect x="0px" y="0px" height="100%" width="35.0%" rx="20" opacity="40%" fill="orange"> <animate attributeName="fill" values="red;orange;red" dur="2s" repeatCount="indefinite"></animate> </rect> <text x="17.5%" y="50%" class="label" style="fill:black">m2</text> </svg><svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="dodgerblue"></rect> <text x="11.5%" y="82.5%" class="label" style="fill:black">ncg0</text> <rect x="25.0%" y="33%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="limegreen"></rect> <text x="36.5%" y="82.5%" class="label" style="fill:black">ncg1</text> <rect x="50.0%" y="33%" height="66.6%" width="47.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="74.0%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <rect x="00.0%" height="31%" width="22.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="11.5%" y="16.66%" class="label" style="fill:black">m0</text> <rect x="25.0%" height="31%" width="22.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="36.5%" y="16.66%" class="label" style="fill:black">m1</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="blue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> </g> <g fill="green"> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> </g> <g fill="gray"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>The model will be placed <em>across</em> NeuronCore Groups since there is no obvious group to assign the model to according to the environment variable configuration. Depending on the individual model and application requirements, the placement here may not be optimal.</p> </div> <div class="section" id="issue-multiple-model-copies"> <h3><a class="toc-backref" href="#id14">Issue: Multiple Model Copies</a><a class="headerlink" href="#issue-multiple-model-copies" title="Permalink to this headline">#</a></h3> <p>It is common in inference serving applications to use multiple replicas of a single model across different NeuronCores. This allows the hardware to be fully utilized to maximize throughput. In this scenario, when using NeuronCore Groups, the only way to replicate a model on multiple NeuronCores is to create a <em>new model</em> object. In the example below, 4 models loads are performed to place a model in each NeuronCore Group.</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURONCORE_GROUP_SIZES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'2,2,2,2'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="n">models</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">4</span><span class="p">):</span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-2-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="n">models</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">model</span><span class="p">)</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } .small { font-family: Consolas, monaco, monospace; font-size: 1.5vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33.0%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="dodgerblue"></rect> <text x="11.5%" y="82.5%" class="label" style="fill:black">ncg0</text> <rect x="25.0%" y="33.0%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="limegreen"></rect> <text x="36.5%" y="82.5%" class="label" style="fill:black">ncg1</text> <rect x="50.0%" y="33.0%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="red"></rect> <text x="61.5%" y="82.5%" class="label" style="fill:black">ncg2</text> <rect x="75.0%" y="33.0%" height="66.6%" width="22.5%" rx="20" opacity="40%" fill="violet"></rect> <text x="86.5%" y="82.5%" class="label" style="fill:black">ncg3</text> <!-- Models --> <rect x="00.0%" height="31%" width="22.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="11.5%" y="16.66%" class="small" style="fill:black">models[0]</text> <rect x="25.0%" height="31%" width="22.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="36.5%" y="16.66%" class="small" style="fill:black">models[1]</text> <rect x="50.0%" height="31%" width="22.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="61.5%" y="16.66%" class="small" style="fill:black">models[2]</text> <rect x="75.0%" height="31%" width="22.5%" rx="20" opacity="40%" fill="orange"></rect> <text x="86.5%" y="16.66%" class="small" style="fill:black">models[3]</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="blue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> </g> <g fill="green"> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> </g> <g fill="red"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> </g> <g fill="violet"> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>The largest consequence of this type of model allocation is that the application code is responsible for routing inference requests to models. There are a variety of ways to implement the inference switching but in all cases routing logic needs to be implemented in the application code.</p> </div> <div class="section" id="issue-summary"> <h3><a class="toc-backref" href="#id15">Issue Summary</a><a class="headerlink" href="#issue-summary" title="Permalink to this headline">#</a></h3> <p>The use of <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> has the following problems:</p> <ul class="simple"> <li><p><strong>Variable Sized Models</strong>: Models which require crossing NeuronCore Group boundaries may be placed poorly. This means group configuration limits the size of which models can be loaded.</p></li> <li><p><strong>Model Load Order</strong>: Models are loaded to NeuronCore Groups greedily. This means that the order of model loads can potentially negatively affect application performance by causing unintentional overlap.</p></li> <li><p><strong>Implicit Placement</strong>: NeuronCore Groups cannot be explicitly chosen in the application code.</p></li> <li><p><strong>Manual Replication</strong>: When loading multiple copies of a model to different NeuronCore Groups, this requires that multiple model handles are used.</p></li> </ul> </div> </div> <div class="section" id="experimental-explicit-core-placement"> <span id="torch-placement-explicit"></span><h2><a class="toc-backref" href="#id16">Experimental: Explicit Core Placement</a><a class="headerlink" href="#experimental-explicit-core-placement" title="Permalink to this headline">#</a></h2> <p>To address the limitations of <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code>, a new set of APIs has been added which allows specific NeuronCores to be chosen by the application code. These can be found in the <span class="xref std std-ref">torch_neuron_core_placement_api</span> documentation.</p> <div class="section" id="example-manual-core-selection"> <h3><a class="toc-backref" href="#id17">Example: Manual Core Selection</a><a class="headerlink" href="#example-manual-core-selection" title="Permalink to this headline">#</a></h3> <p>The most direct usage of the placement APIs is to manually select the start NeuronCore that each model is loaded to. This will automatically use as many NeuronCores as is necessary for that model (1 for most models, &gt;1 for NeuronCore Pipelines models).</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_NUM_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'4'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="c1"># NOTE: Order of loads does NOT matter</span> <span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="mi">2</span><span class="p">):</span> <span class="n">m1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-2-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc2-nc3</span> <span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="mi">0</span><span class="p">):</span> <span class="n">m2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-3-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0-nc2</span> <span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="mi">0</span><span class="p">):</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-2-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc0-nc1</span> <span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="mi">3</span><span class="p">):</span> <span class="n">m3</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads to nc3</span> </pre></div> </div> <svg width="100%" height="50px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Models --> <g opacity="40%" fill="orange"> <rect x="00.0%" height="100%" width="35.0%" rx="20"> <animate attributeName="opacity" values="1;0;0;1;1;1;1" dur="5s" repeatCount="indefinite"></animate> </rect> <rect x="37.5%" height="100%" width="10.0%" rx="20"> <animate attributeName="opacity" values="1;0;0;0;0;1;1" dur="5s" repeatCount="indefinite"></animate> </rect> </g> <text x="17.5%" y="50%" class="label" style="fill:black">m2 <animate attributeName="opacity" values="1;0;0;1;1;1;1" dur="5s" repeatCount="indefinite"></animate> </text> <text x="42.5%" y="50%" class="label" style="fill:black">m3 <animate attributeName="opacity" values="1;0;0;0;0;1;1" dur="5s" repeatCount="indefinite"></animate> </text> </svg> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="47.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="23.5%" y="82.5%" class="label" style="fill:black">allocated</text> <rect x="50.0%" y="33%" height="66.6%" width="47.5%" rx="20" opacity="20%" fill="gray"></rect> <text x="74.0%" y="82.5%" class="label" style="fill:black">unallocated</text> <!-- Models --> <g opacity="40%" fill="orange"> <rect x="00.0%" height="31%" width="22.5%" rx="20"> <animate attributeName="opacity" values="1;0;0;0;1;1;1" dur="5s" repeatCount="indefinite"></animate> </rect> <rect x="25.0%" height="31%" width="22.5%" rx="20"> <animate attributeName="opacity" values="1;0;1;1;1;1;1" dur="5s" repeatCount="indefinite"></animate> </rect> </g> <text x="11.5%" y="16.66%" class="label" style="fill:black">m0 <animate attributeName="opacity" values="1;0;0;0;1;1;1" dur="5s" repeatCount="indefinite"></animate> </text> <text x="36.5%" y="16.66%" class="label" style="fill:black">m1 <animate attributeName="opacity" values="1;0;1;1;1;1;1" dur="5s" repeatCount="indefinite"></animate> </text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> </g> <g fill="gray"> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>Note that this directly solves the <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> issues of:</p> <ul class="simple"> <li><p><strong>Variable Sized Models</strong>: Now since models are directly placed on the NeuronCores requested by the application, there is no disconnect between the model sizes and NeuronCore Group sizes.</p></li> <li><p><strong>Model Load Order</strong>: Since the NeuronCores are explicitly selected, there is no need to be careful about the order in which models are loaded since they can be placed deterministically regardless of the load order.</p></li> <li><p><strong>Implicit Placement</strong>: Similarly, explicit placement means there is no chance that a model will end up being allocated to an incorrect NeuronCore Group.</p></li> </ul> </div> <div class="section" id="example-automatic-multicore"> <h3><a class="toc-backref" href="#id18">Example: Automatic Multicore</a><a class="headerlink" href="#example-automatic-multicore" title="Permalink to this headline">#</a></h3> <p>Using explicit core placement it is possible to replicate a model to multiple NeuronCores simultaneously. This means that a single model object within python can utilize all available NeuronCores (or NeuronCores allocated to the process).</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_NUM_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'8'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">multicore_context</span><span class="p">():</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-1-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads replications to nc0-nc7</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="97.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="50%" y="82.5%" class="label" style="fill:black">allocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="00.0%" width="10%" height="31%" rx="20"></rect> <rect x="12.5%" width="10%" height="31%" rx="20"></rect> <rect x="25.0%" width="10%" height="31%" rx="20"></rect> <rect x="37.5%" width="10%" height="31%" rx="20"></rect> <rect x="50.0%" width="10%" height="31%" rx="20"></rect> <rect x="62.5%" width="10%" height="31%" rx="20"></rect> <rect x="75.0%" width="10%" height="31%" rx="20"></rect> <rect x="87.5%" width="10%" height="31%" rx="20"></rect> </g> <text x="05.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="17.5%" y="16.66%" class="label" style="fill:black">m0</text> <text x="30.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="42.5%" y="16.66%" class="label" style="fill:black">m0</text> <text x="55.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="67.5%" y="16.66%" class="label" style="fill:black">m0</text> <text x="80.0%" y="16.66%" class="label" style="fill:black">m0</text> <text x="92.5%" y="16.66%" class="label" style="fill:black">m0</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p>This addresses the last <code class="docutils literal notranslate"><span class="pre">NEURONCORE_GROUP_SIZES</span></code> issue of:</p> <ul class="simple"> <li><p><strong>Manual Replication</strong>: Since models can be automatically replicated to multiple NeuronCores, this means that applications no longer need to implement routing logic and perform multiple loads.</p></li> </ul> <p>This API has a secondary benefit that the exact same loading logic can be used on an <code class="docutils literal notranslate"><span class="pre">inf1.xlarge</span></code> or an <code class="docutils literal notranslate"><span class="pre">inf1.6xlarge</span></code>. In either case, it will use all of the NeuronCores that are visible to the process. This means that no special logic needs to be coded for different instance types.</p> </div> <div class="section" id="example-explicit-replication"> <h3><a class="toc-backref" href="#id19">Example: Explicit Replication</a><a class="headerlink" href="#example-explicit-replication" title="Permalink to this headline">#</a></h3> <p>Replication is also possible with the <code class="xref py py-func docutils literal notranslate"><span class="pre">neuron_cores_context()</span></code> API. The number of replications is chosen by <code class="docutils literal notranslate"><span class="pre">replications</span> <span class="pre">=</span> <span class="pre">floor(nc_count</span> <span class="pre">/</span> <span class="pre">cores_per_model)</span></code>.</p> <p><strong>Environment Setup</strong>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_NUM_CORES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'8'</span> </pre></div> </div> <p><strong>Python Script</strong>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="k">with</span> <span class="n">torch_neuron</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">neuron_cores_context</span><span class="p">(</span><span class="n">start_nc</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">nc_count</span><span class="o">=</span><span class="mi">4</span><span class="p">):</span> <span class="n">m0</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model-with-2-neuron-pipeline-cores.pt'</span><span class="p">)</span> <span class="c1"># Loads replications to nc2-nc5</span> </pre></div> </div> <svg width="100%" height="150px" preserveAspectRatio="xMidYMin" xmlns="http://www.w3.org/2000/svg"> <!-- Font --> <style> .label { font-family: Consolas, monaco, monospace; font-size: 2vw; text-anchor: middle; alignment-baseline: central; fill: white; dominant-baseline: middle; } </style> <!-- Neuron Core Groups --> <rect x="00.0%" y="33%" height="66.6%" width="97.5%" rx="20" opacity="40%" fill="slateblue"></rect> <text x="50%" y="82.5%" class="label" style="fill:black">allocated</text> <!-- Models --> <g fill="orange" opacity="40%"> <rect x="25.0%" width="22.5%" height="31%" rx="20"></rect> <rect x="50.0%" width="22.5%" height="31%" rx="20"></rect> </g> <text x="36.5%" y="16.66%" class="label" style="fill:black">m0</text> <text x="61.5%" y="16.66%" class="label" style="fill:black">m0</text> <!-- Neuron Cores --> <defs> <rect id="nc" x="0" y="33.3%" height="33.3%" width="10%" stroke="black" stroke-width="1px" rx="10"></rect> </defs> <g fill="slateblue"> <use href="#nc" x="00.0%"></use> <use href="#nc" x="12.5%"></use> <use href="#nc" x="25.0%"></use> <use href="#nc" x="37.5%"></use> <use href="#nc" x="50.0%"></use> <use href="#nc" x="62.5%"></use> <use href="#nc" x="75.0%"></use> <use href="#nc" x="87.5%"></use> </g> <text x="05.0%" y="50%" class="label">nc0</text> <text x="17.5%" y="50%" class="label">nc1</text> <text x="30.0%" y="50%" class="label">nc2</text> <text x="42.5%" y="50%" class="label">nc3</text> <text x="55.0%" y="50%" class="label">nc4</text> <text x="67.5%" y="50%" class="label">nc5</text> <text x="80.0%" y="50%" class="label">nc6</text> <text x="92.5%" y="50%" class="label">nc7</text> </svg><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../torch-lstm-support.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Developer Guide - PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) <code class="xref py py-class docutils literal notranslate"><span class="pre">LSTM</span></code> Support</p> </div> </a> <a class="right-next" id="next-link" href="../../misc-inference-torch-neuron.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Misc (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:01.281Z
PyTorch Neuron (torch-neuron) Supported operators — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html
# PyTorch Neuron (torch-neuron) Supported operators — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## PyTorch Neuron (`torch-neuron`) Supported operators[#](#pytorch-neuron-torch-neuron-supported-operators "Permalink to this headline") Current operator lists may be generated with these commands inside python: ``` import torch.neuron print(*torch.neuron.get_supported_operations(), sep='\n') ``` ## PyTorch Neuron release \[package version 1.\*.\*.2.9.1.0, SDK 2.13.0\][#](#pytorch-neuron-release-package-version-1-2-9-1-0-sdk-2-13-0 "Permalink to this headline") Date: 08/28/2023 Added support for new operators: - `aten::clamp_min` - `aten::clamp_max` ## PyTorch Neuron release \[2.9.0.0\][#](#pytorch-neuron-release-2-9-0-0 "Permalink to this headline") Date: 03/28/2023 Added support for new operators: - `aten::tensordot` - `aten::adaptive_avg_pool1d` - `aten::prelu` - `aten::reflection_pad2d` - `aten::baddbmm` - `aten::repeat` ## PyTorch Neuron release \[2.5.0.0\][#](#pytorch-neuron-release-2-5-0-0 "Permalink to this headline") Date: 11/23/2022 Added support for new operators: - `aten::threshold` - `aten::roll` - `aten::instance_norm` - `aten::amin` - `aten::amax` - `aten::new_empty` - `aten::new_ones` - `aten::tril` - `aten::triu` - `aten::zero_` - `aten::all` - `aten::broadcast_tensors` - `aten::broadcast_to` - `aten::logical_and` - `aten::logical_not` - `aten::logical_or` - `aten::logical_xor` - `aten::_convolution_mode` Added **limited** support for new operators: - LSTM Operations. See: [Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support](../../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html#torch-neuron-lstm-support) - `aten::lstm` - `aten::_pack_padded_sequence` - `aten::_pad_packed_sequence` - `aten::norm`: Supported when `p` argument is one of (`1`, `2`, `inf`, `-inf`, `'fro'`) ## PyTorch Neuron release \[2.2.0.0\][#](#pytorch-neuron-release-2-2-0-0 "Permalink to this headline") Date: 03/25/2022 Added support for new operators: - `aten::max_pool2d_with_indices`: Fully supported (Was previously supported only when indices were unused). ## PyTorch Neuron release \[2.1.7.0\][#](#pytorch-neuron-release-2-1-7-0 "Permalink to this headline") Date: 01/20/2022 Added support for new operators: - `aten::bucketize` - `aten::any` - `aten::remainder` - `aten::clip` - `aten::repeat_interleave` - `aten::tensor_split` - `aten::split_with_sizes` - `aten::isnan` - `aten::embedding_renorm_` - `aten::dot` - `aten::mv` - `aten::hardsigmoid` - `aten::hardswish` - `aten::trunc` - `aten::one_hot`: Supported when `num_classes` is known at trace time. The dynamic version of this operation when `num_classes = -1` is not supported. - `aten::adaptive_max_pool1d` - `aten::adaptive_max_pool2d` ### PyTorch Neuron Release \[2.0.536.0\][#](#pytorch-neuron-release-2-0-536-0 "Permalink to this headline") - The following are operators with limited support on Neuron. Unlike fully supported operators, these operators are not returned when using `torch_neuron.get_supported_operations()`. See each operator description for conditional support: - `aten::max_pool2d_with_indices` - Supported when indices outputs are not used by a downstream operation. This allows the operation to be compiled to Neuron when it is equivalent to an `aten::max_pool2d`. - `aten::max_pool3d_with_indices` - Supported when indices outputs are not used by a downstream operation. This allows the operation to be compiled to Neuron when it is equivalent to an `aten::max_pool3d`. - `aten::where` - Supported when used as a conditional selection (3-argument variant). Unsupported when used to generate a dynamic list of indices (1-argument variant). See [`torch.where()`](https://pytorch.org/docs/master/generated/torch.where.html#torch.where "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). ### PyTorch Neuron Release \[2.0.318.0\][#](#pytorch-neuron-release-2-0-318-0 "Permalink to this headline") Added support for new operators: - `aten::empty_like` - `aten::log` - `aten::type_as` - `aten::movedim` - `aten::einsum` - `aten::argmax` - `aten::min` - `aten::argmin` - `aten::abs` - `aten::cos` - `aten::sin` - `aten::linear` - `aten::pixel_shuffle` - `aten::group_norm` - `aten::_weight_norm` ### PyTorch Neuron Release \[1.5.21.0\][#](#pytorch-neuron-release-1-5-21-0 "Permalink to this headline") No change ### PyTorch Neuron Release \[1.5.7.0\][#](#pytorch-neuron-release-1-5-7-0 "Permalink to this headline") Added support for new operators: - `aten::erf` - `prim::DictConstruct` ### PyTorch Neuron Release \[1.4.1.0\][#](#pytorch-neuron-release-1-4-1-0 "Permalink to this headline") No change ### PyTorch Neuron Release \[1.3.5.0\][#](#pytorch-neuron-release-1-3-5-0 "Permalink to this headline") Added support for new operators: - `aten::numel` - `aten::ones_like` - `aten::reciprocal` - `aten::topk` ### PyTorch Neuron Release \[1.2.16.0\][#](#pytorch-neuron-release-1-2-16-0 "Permalink to this headline") No change ### PyTorch Neuron Release \[1.2.15.0\][#](#pytorch-neuron-release-1-2-15-0 "Permalink to this headline") No change ### PyTorch Neuron Release \[1.2.3.0\][#](#pytorch-neuron-release-1-2-3-0 "Permalink to this headline") Added support for new operators: - `aten::silu` - `aten::zeros_like` ### PyTorch Neuron Release \[1.1.7.0\][#](#pytorch-neuron-release-1-1-7-0 "Permalink to this headline") Added support for new operators: - `aten::_shape_as_tensor` - `aten::chunk` - `aten::empty` - `aten::masked_fill` ### PyTorch Neuron Release \[1.0.24045.0\][#](#pytorch-neuron-release-1-0-24045-0 "Permalink to this headline") Added support for new operators: - `aten::__and__` - `aten::bmm` - `aten::clone` - `aten::expand_as` - `aten::fill_` - `aten::floor_divide` - `aten::full` - `aten::hardtanh` - `aten::hardtanh_` - `aten::le` - `aten::leaky_relu` - `aten::lt` - `aten::mean` - `aten::ne` - `aten::softplus` - `aten::unbind` - `aten::upsample_bilinear2d` ### PyTorch Neuron Release \[1.0.1720.00\][#](#pytorch-neuron-release-1-0-1720-00 "Permalink to this headline") Added support for new operators: - `aten::constant_pad_nd` - `aten::meshgrid` ### PyTorch Neuron Release \[1.0.1532.0\][#](#pytorch-neuron-release-1-0-1532-0 "Permalink to this headline") Added support for new operators: - `aten::ones` ### PyTorch Neuron Release \[1.0.1522.0\][#](#pytorch-neuron-release-1-0-1522-0 "Permalink to this headline") No change ### PyTorch Neuron Release \[1.0.1386.0\][#](#pytorch-neuron-release-1-0-1386-0 "Permalink to this headline") Added support for new operators: - `aten::ceil` - `aten::clamp` - `aten::eq` - `aten::exp` - `aten::expand_as` - `aten::flip` - `aten::full_like` - `aten::ge` - `aten::gt` - `aten::log2` - `aten::log_softmax` - `aten::max` - `aten::neg` - `aten::relu` - `aten::rsqrt` - `aten::scalarImplicit` - `aten::sqrt` - `aten::squeeze` - `aten::stack` - `aten::sub` - `aten::sum` - `aten::true_divide` - `aten::upsample_nearest2d` - `prim::Constant` - `prim::GetAttr` - `prim::ImplicitTensorToNum` - `prim::ListConstruct` - `prim::ListUnpack` - `prim::NumToTensor` - `prim::TupleConstruct` - `prim::TupleUnpack` Please note, primitives are included in this list from this release. ### PyTorch Neuron Release \[1.0.1168.0\][#](#pytorch-neuron-release-1-0-1168-0 "Permalink to this headline") Added support for new operators: - `aten::ScalarImplicit` ### PyTorch Neuron Release \[1.0.1001.0\][#](#pytorch-neuron-release-1-0-1001-0 "Permalink to this headline") Added support for new operators: - `aten::detach` - `aten::floor` - `aten::gelu` - `aten::pow` - `aten::sigmoid` - `aten::split` Remove support for operators: - `aten::embedding`: Does not meet **performance** criteria - `aten::erf`: Error function does not meet **accuracy** criteria - `aten::tf_dtype_from_torch`: Internal support function, not an operator ### PyTorch Neuron Release \[1.0.825.0\][#](#pytorch-neuron-release-1-0-825-0 "Permalink to this headline") No change ### PyTorch Neuron Release \[1.0.763.0\][#](#pytorch-neuron-release-1-0-763-0 "Permalink to this headline") Added support for new operators: - `aten::Int` - `aten::arange` - `aten::contiguous` - `aten::div` - `aten::embedding` - `aten::erf` - `aten::expand` - `aten::eye` - `aten::index_select` - `aten::layer_norm` - `aten::matmul` - `aten::mm` - `aten::permute` - `aten::reshape` - `aten::rsub` - `aten::select` - `aten::size` - `aten::slice` - `aten::softmax` - `aten::tf_dtype_from_torch` - `aten::to` - `aten::transpose` - `aten::unsqueeze` - `aten::view` - `aten::zeros` Remove support for operators: - `aten::tf_broadcastable_slice`: Internal support function, not an operator - `aten::tf_padding`: Internal support function, not an operator These operators were already supported previously: - `aten::_convolution` - `aten::adaptive_avg_pool2d` - `aten::add` - `aten::add_` - `aten::addmm` - `aten::avg_pool2d` - `aten::batch_norm` - `aten::cat` - `aten::dimension_value` - `aten::dropout` - `aten::flatten` - `aten::max_pool2d` - `aten::mul` - `aten::relu_` - `aten::t` - `aten::tanh` - `aten::values` - `prim::Constant` - `prim::GetAttr` - `prim::ListConstruct` - `prim::ListUnpack` - `prim::TupleConstruct` - `prim::TupleUnpack` ### PyTorch Neuron Release \[1.0.672.0\][#](#pytorch-neuron-release-1-0-672-0 "Permalink to this headline") No change ### PyTorch Neuron Release \[1.0.552.0\][#](#pytorch-neuron-release-1-0-552-0 "Permalink to this headline") Added support for new operators: - `aten::_convolution` - `aten::adaptive_avg_pool2d` - `aten::add` - `aten::add_` - `aten::addmm` - `aten::avg_pool2d` - `aten::batch_norm` - `aten::cat` - `aten::dimension_value` - `aten::dropout` - `aten::flatten` - `aten::max_pool2d` - `aten::mul` - `aten::relu_` - `aten::t` - `aten::tanh` - `aten::tf_broadcastable_slice` - `aten::tf_padding` - `aten::values` - `prim::Constant` - `prim::GetAttr` - `prim::ListConstruct` - `prim::ListUnpack` - `prim::TupleConstruct` - `prim::TupleUnpack` _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuron) Supported operators — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Troubleshooting Guide for PyTorch Neuron (torch-neuron)" href="../../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> <link rel="prev" title="Misc (torch-neuron)" href="../../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../neuron-cc.html"> What's New </a> </li> <li class="toctree-l4 current active"> <a class="reference internal" href="index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Frelease-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-package-version-1-2-9-1-0-sdk-2-13-0"> PyTorch Neuron release [package version 1.*.*.2.9.1.0, SDK 2.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-9-0-0"> PyTorch Neuron release [2.9.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-5-0-0"> PyTorch Neuron release [2.5.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-2-0-0"> PyTorch Neuron release [2.2.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-1-7-0"> PyTorch Neuron release [2.1.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-536-0"> PyTorch Neuron Release [2.0.536.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-318-0"> PyTorch Neuron Release [2.0.318.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-5-21-0"> PyTorch Neuron Release [1.5.21.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-5-7-0"> PyTorch Neuron Release [1.5.7.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-4-1-0"> PyTorch Neuron Release [1.4.1.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-3-5-0"> PyTorch Neuron Release [1.3.5.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-2-16-0"> PyTorch Neuron Release [1.2.16.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-2-15-0"> PyTorch Neuron Release [1.2.15.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-2-3-0"> PyTorch Neuron Release [1.2.3.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-1-7-0"> PyTorch Neuron Release [1.1.7.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-24045-0"> PyTorch Neuron Release [1.0.24045.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1720-00"> PyTorch Neuron Release [1.0.1720.00] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1532-0"> PyTorch Neuron Release [1.0.1532.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1522-0"> PyTorch Neuron Release [1.0.1522.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1386-0"> PyTorch Neuron Release [1.0.1386.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1168-0"> PyTorch Neuron Release [1.0.1168.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1001-0"> PyTorch Neuron Release [1.0.1001.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-825-0"> PyTorch Neuron Release [1.0.825.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-763-0"> PyTorch Neuron Release [1.0.763.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-672-0"> PyTorch Neuron Release [1.0.672.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-552-0"> PyTorch Neuron Release [1.0.552.0] </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuron) Supported operators</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-package-version-1-2-9-1-0-sdk-2-13-0"> PyTorch Neuron release [package version 1.*.*.2.9.1.0, SDK 2.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-9-0-0"> PyTorch Neuron release [2.9.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-5-0-0"> PyTorch Neuron release [2.5.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-2-0-0"> PyTorch Neuron release [2.2.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-1-7-0"> PyTorch Neuron release [2.1.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-536-0"> PyTorch Neuron Release [2.0.536.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-318-0"> PyTorch Neuron Release [2.0.318.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-5-21-0"> PyTorch Neuron Release [1.5.21.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-5-7-0"> PyTorch Neuron Release [1.5.7.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-4-1-0"> PyTorch Neuron Release [1.4.1.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-3-5-0"> PyTorch Neuron Release [1.3.5.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-2-16-0"> PyTorch Neuron Release [1.2.16.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-2-15-0"> PyTorch Neuron Release [1.2.15.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-2-3-0"> PyTorch Neuron Release [1.2.3.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-1-7-0"> PyTorch Neuron Release [1.1.7.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-24045-0"> PyTorch Neuron Release [1.0.24045.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1720-00"> PyTorch Neuron Release [1.0.1720.00] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1532-0"> PyTorch Neuron Release [1.0.1532.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1522-0"> PyTorch Neuron Release [1.0.1522.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1386-0"> PyTorch Neuron Release [1.0.1386.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1168-0"> PyTorch Neuron Release [1.0.1168.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-1001-0"> PyTorch Neuron Release [1.0.1001.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-825-0"> PyTorch Neuron Release [1.0.825.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-763-0"> PyTorch Neuron Release [1.0.763.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-672-0"> PyTorch Neuron Release [1.0.672.0] </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-1-0-552-0"> PyTorch Neuron Release [1.0.552.0] </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="pytorch-neuron-torch-neuron-supported-operators"> <span id="neuron-cc-ops-pytorch"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Supported operators<a class="headerlink" href="#pytorch-neuron-torch-neuron-supported-operators" title="Permalink to this headline">#</a></h1> <p>Current operator lists may be generated with these commands inside python:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch.neuron</span> <span class="nb">print</span><span class="p">(</span><span class="o">*</span><span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">get_supported_operations</span><span class="p">(),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> </pre></div> </div> <div class="section" id="pytorch-neuron-release-package-version-1-2-9-1-0-sdk-2-13-0"> <span id="pytorch-neuron-release-2130"></span><h2>PyTorch Neuron release [package version 1.*.*.2.9.1.0, SDK 2.13.0]<a class="headerlink" href="#pytorch-neuron-release-package-version-1-2-9-1-0-sdk-2-13-0" title="Permalink to this headline">#</a></h2> <p>Date: 08/28/2023</p> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::clamp_min</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::clamp_max</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-2-9-0-0"> <span id="pytorch-neuron-release-2900"></span><h2>PyTorch Neuron release [2.9.0.0]<a class="headerlink" href="#pytorch-neuron-release-2-9-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 03/28/2023</p> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tensordot</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::adaptive_avg_pool1d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::prelu</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::reflection_pad2d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::baddbmm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::repeat</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-2-5-0-0"> <span id="pytorch-neuron-release-2500"></span><h2>PyTorch Neuron release [2.5.0.0]<a class="headerlink" href="#pytorch-neuron-release-2-5-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 11/23/2022</p> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::threshold</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::roll</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::instance_norm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::amin</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::amax</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::new_empty</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::new_ones</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tril</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::triu</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::zero_</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::all</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::broadcast_tensors</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::broadcast_to</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::logical_and</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::logical_not</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::logical_or</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::logical_xor</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::_convolution_mode</span></code></p></li> </ul> <p>Added <strong>limited</strong> support for new operators:</p> <ul class="simple"> <li><p>LSTM Operations. See: <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html#torch-neuron-lstm-support"><span class="std std-ref">Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support</span></a></p> <ul> <li><p><code class="docutils literal notranslate"><span class="pre">aten::lstm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::_pack_padded_sequence</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::_pad_packed_sequence</span></code></p></li> </ul> </li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::norm</span></code>: Supported when <code class="docutils literal notranslate"><span class="pre">p</span></code> argument is one of (<code class="docutils literal notranslate"><span class="pre">1</span></code>, <code class="docutils literal notranslate"><span class="pre">2</span></code>, <code class="docutils literal notranslate"><span class="pre">inf</span></code>, <code class="docutils literal notranslate"><span class="pre">-inf</span></code>, <code class="docutils literal notranslate"><span class="pre">'fro'</span></code>)</p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-2-2-0-0"> <span id="pytorch-neuron-release-2200"></span><h2>PyTorch Neuron release [2.2.0.0]<a class="headerlink" href="#pytorch-neuron-release-2-2-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 03/25/2022</p> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::max_pool2d_with_indices</span></code>: Fully supported (Was previously supported only when indices were unused).</p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-2-1-7-0"> <span id="pytorch-neuron-release-2170"></span><h2>PyTorch Neuron release [2.1.7.0]<a class="headerlink" href="#pytorch-neuron-release-2-1-7-0" title="Permalink to this headline">#</a></h2> <p>Date: 01/20/2022</p> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::bucketize</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::any</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::remainder</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::clip</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::repeat_interleave</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tensor_split</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::split_with_sizes</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::isnan</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::embedding_renorm_</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::dot</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::mv</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::hardsigmoid</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::hardswish</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::trunc</span></code></p></li> <li><dl class="simple"> <dt><code class="docutils literal notranslate"><span class="pre">aten::one_hot</span></code>: Supported when <code class="docutils literal notranslate"><span class="pre">num_classes</span></code> is known at trace time.</dt><dd><p>The dynamic version of this operation when <code class="docutils literal notranslate"><span class="pre">num_classes</span> <span class="pre">=</span> <span class="pre">-1</span></code> is not supported.</p> </dd> </dl> </li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::adaptive_max_pool1d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::adaptive_max_pool2d</span></code></p></li> </ul> <div class="section" id="pytorch-neuron-release-2-0-536-0"> <span id="pytorch-neuron-release-205360"></span><h3>PyTorch Neuron Release [2.0.536.0]<a class="headerlink" href="#pytorch-neuron-release-2-0-536-0" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>The following are operators with limited support on Neuron. Unlike fully supported operators, these operators are not returned when using <code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.get_supported_operations()</span></code>. See each operator description for conditional support:</p> <ul> <li><p><code class="docutils literal notranslate"><span class="pre">aten::max_pool2d_with_indices</span></code> - Supported when indices outputs are not used by a downstream operation. This allows the operation to be compiled to Neuron when it is equivalent to an <code class="docutils literal notranslate"><span class="pre">aten::max_pool2d</span></code>.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::max_pool3d_with_indices</span></code> - Supported when indices outputs are not used by a downstream operation. This allows the operation to be compiled to Neuron when it is equivalent to an <code class="docutils literal notranslate"><span class="pre">aten::max_pool3d</span></code>.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::where</span></code> - Supported when used as a conditional selection (3-argument variant). Unsupported when used to generate a dynamic list of indices (1-argument variant). See <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.where.html#torch.where" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.where()</span></code></a>.</p></li> </ul> </li> </ul> </div> <div class="section" id="pytorch-neuron-release-2-0-318-0"> <span id="pytorch-neuron-release-203180"></span><h3>PyTorch Neuron Release [2.0.318.0]<a class="headerlink" href="#pytorch-neuron-release-2-0-318-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::empty_like</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::log</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::type_as</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::movedim</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::einsum</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::argmax</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::min</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::argmin</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::abs</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::cos</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::sin</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::linear</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::pixel_shuffle</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::group_norm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::_weight_norm</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-5-21-0"> <span id="pytorch-neuron-release-15210"></span><h3>PyTorch Neuron Release [1.5.21.0]<a class="headerlink" href="#pytorch-neuron-release-1-5-21-0" title="Permalink to this headline">#</a></h3> <p>No change</p> </div> <div class="section" id="pytorch-neuron-release-1-5-7-0"> <span id="pytorch-neuron-release-1570"></span><h3>PyTorch Neuron Release [1.5.7.0]<a class="headerlink" href="#pytorch-neuron-release-1-5-7-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::erf</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::DictConstruct</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-4-1-0"> <span id="pytorch-neuron-release-1410"></span><h3>PyTorch Neuron Release [1.4.1.0]<a class="headerlink" href="#pytorch-neuron-release-1-4-1-0" title="Permalink to this headline">#</a></h3> <p>No change</p> </div> <div class="section" id="pytorch-neuron-release-1-3-5-0"> <span id="pytorch-neuron-release-1350"></span><h3>PyTorch Neuron Release [1.3.5.0]<a class="headerlink" href="#pytorch-neuron-release-1-3-5-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::numel</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::ones_like</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::reciprocal</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::topk</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-2-16-0"> <span id="pytorch-neuron-release-12160"></span><h3>PyTorch Neuron Release [1.2.16.0]<a class="headerlink" href="#pytorch-neuron-release-1-2-16-0" title="Permalink to this headline">#</a></h3> <p>No change</p> </div> <div class="section" id="pytorch-neuron-release-1-2-15-0"> <span id="pytorch-neuron-release-12150"></span><h3>PyTorch Neuron Release [1.2.15.0]<a class="headerlink" href="#pytorch-neuron-release-1-2-15-0" title="Permalink to this headline">#</a></h3> <p>No change</p> </div> <div class="section" id="pytorch-neuron-release-1-2-3-0"> <span id="pytorch-neuron-release-1230"></span><h3>PyTorch Neuron Release [1.2.3.0]<a class="headerlink" href="#pytorch-neuron-release-1-2-3-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::silu</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::zeros_like</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-1-7-0"> <span id="pytorch-neuron-release-1170"></span><h3>PyTorch Neuron Release [1.1.7.0]<a class="headerlink" href="#pytorch-neuron-release-1-1-7-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::_shape_as_tensor</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::chunk</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::empty</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::masked_fill</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-0-24045-0"> <span id="pytorch-neuron-release-10240450"></span><h3>PyTorch Neuron Release [1.0.24045.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-24045-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::__and__</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::bmm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::clone</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::expand_as</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::fill_</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::floor_divide</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::full</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::hardtanh</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::hardtanh_</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::le</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::leaky_relu</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::lt</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::mean</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::ne</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::softplus</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::unbind</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::upsample_bilinear2d</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-0-1720-00"> <span id="pytorch-neuron-release-10172000"></span><h3>PyTorch Neuron Release [1.0.1720.00]<a class="headerlink" href="#pytorch-neuron-release-1-0-1720-00" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::constant_pad_nd</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::meshgrid</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-0-1532-0"> <span id="pytorch-neuron-release-1015320"></span><h3>PyTorch Neuron Release [1.0.1532.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-1532-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::ones</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-0-1522-0"> <span id="pytorch-neuron-release-1015220"></span><h3>PyTorch Neuron Release [1.0.1522.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-1522-0" title="Permalink to this headline">#</a></h3> <p>No change</p> </div> <div class="section" id="pytorch-neuron-release-1-0-1386-0"> <span id="pytorch-neuron-release-1013860"></span><h3>PyTorch Neuron Release [1.0.1386.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-1386-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::ceil</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::clamp</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::eq</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::exp</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::expand_as</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::flip</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::full_like</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::ge</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::gt</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::log2</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::log_softmax</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::max</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::neg</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::relu</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::rsqrt</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::scalarImplicit</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::sqrt</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::squeeze</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::stack</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::sub</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::sum</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::true_divide</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::upsample_nearest2d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::Constant</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::GetAttr</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::ImplicitTensorToNum</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::ListConstruct</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::ListUnpack</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::NumToTensor</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::TupleConstruct</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::TupleUnpack</span></code></p></li> </ul> <p>Please note, primitives are included in this list from this release.</p> </div> <div class="section" id="pytorch-neuron-release-1-0-1168-0"> <span id="pytorch-neuron-release-1011680"></span><h3>PyTorch Neuron Release [1.0.1168.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-1168-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::ScalarImplicit</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-0-1001-0"> <span id="pytorch-neuron-release-1010010"></span><h3>PyTorch Neuron Release [1.0.1001.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-1001-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::detach</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::floor</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::gelu</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::pow</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::sigmoid</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::split</span></code></p></li> </ul> <p>Remove support for operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::embedding</span></code>: Does not meet <strong>performance</strong> criteria</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::erf</span></code>: Error function does not meet <strong>accuracy</strong> criteria</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tf_dtype_from_torch</span></code>: Internal support function, not an operator</p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-0-825-0"> <span id="pytorch-neuron-release-108250"></span><h3>PyTorch Neuron Release [1.0.825.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-825-0" title="Permalink to this headline">#</a></h3> <p>No change</p> </div> <div class="section" id="pytorch-neuron-release-1-0-763-0"> <span id="pytorch-neuron-release-107630"></span><h3>PyTorch Neuron Release [1.0.763.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-763-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::Int</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::arange</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::contiguous</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::div</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::embedding</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::erf</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::expand</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::eye</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::index_select</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::layer_norm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::matmul</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::mm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::permute</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::reshape</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::rsub</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::select</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::size</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::slice</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::softmax</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tf_dtype_from_torch</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::to</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::transpose</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::unsqueeze</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::view</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::zeros</span></code></p></li> </ul> <p>Remove support for operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tf_broadcastable_slice</span></code>: Internal support function, not an operator</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tf_padding</span></code>: Internal support function, not an operator</p></li> </ul> <p>These operators were already supported previously:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::_convolution</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::adaptive_avg_pool2d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::add</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::add_</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::addmm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::avg_pool2d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::batch_norm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::cat</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::dimension_value</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::dropout</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::flatten</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::max_pool2d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::mul</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::relu_</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::t</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tanh</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::values</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::Constant</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::GetAttr</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::ListConstruct</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::ListUnpack</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::TupleConstruct</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::TupleUnpack</span></code></p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-1-0-672-0"> <span id="pytorch-neuron-release-106720"></span><h3>PyTorch Neuron Release [1.0.672.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-672-0" title="Permalink to this headline">#</a></h3> <p>No change</p> </div> <div class="section" id="pytorch-neuron-release-1-0-552-0"> <span id="pytorch-neuron-release-105520"></span><h3>PyTorch Neuron Release [1.0.552.0]<a class="headerlink" href="#pytorch-neuron-release-1-0-552-0" title="Permalink to this headline">#</a></h3> <p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::_convolution</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::adaptive_avg_pool2d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::add</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::add_</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::addmm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::avg_pool2d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::batch_norm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::cat</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::dimension_value</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::dropout</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::flatten</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::max_pool2d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::mul</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::relu_</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::t</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tanh</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tf_broadcastable_slice</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tf_padding</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::values</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::Constant</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::GetAttr</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::ListConstruct</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::ListUnpack</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::TupleConstruct</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::TupleUnpack</span></code></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Misc (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../../frameworks/torch/torch-neuron/troubleshooting-guide.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Troubleshooting Guide for PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:01.762Z
Troubleshooting Guide for PyTorch Neuron (torch-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuron/troubleshooting-guide.html
# Troubleshooting Guide for PyTorch Neuron (torch-neuron) — AWS Neuron Documentation ## General Torch-Neuron issues[#](#general-torch-neuron-issues "Permalink to this headline") If you see an error about “Unknown builtin op: neuron::forward\_1” like below, please ensure that import line “import torch\_neuron” (to register the Neuron custom operation) is in the inference script before using torch.jit.load. ``` Unknown builtin op: neuron::forward_1. Could not find any similar ops to neuron::forward_1. This op may not exist or may not be currently supported in TorchScript. ``` ## torch.jit.trace issues[#](#torch-jit-trace-issues "Permalink to this headline") The /neuron-guide/neuron-frameworks/pytorch-neuron/api-compilation-python-api.rst uses the PyTorch [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") function to generate [`ScriptModule`](https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") models for execution on Inferentia. Due to that, to execute your PyTorch model on Inferentia it must be torch-jit-traceable, otherwise you need to make sure your model is torch-jit-traceable. You can try modifying your underlying PyTorch model code to make it traceable. If it’s not possible to change your model code, you can [write a wrapper around your model](#wrapping-non-traceable-models) that makes it torch-jit-traceable to compile it for Inferentia. Please visit [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") to review the properties that a model must have to be torch-jit-traceable. The PyTorch-Neuron trace API [`torch_neuron.trace()`](api-compilation-python-api.html#torch_neuron.trace "torch_neuron.trace") accepts `**kwargs` for [`torch.jit.trace()`](https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"). For example, you can use the `strict=False` flag to [compile models with dictionary outputs](api-compilation-python-api.html#compiling-models-with-kwargs). ### Compiling models with outputs that are not torch-jit-traceable[#](#compiling-models-with-outputs-that-are-not-torch-jit-traceable "Permalink to this headline") To enable compilation of models with non torch-jit-traceable outputs, you can use a technique that involves writing a wrapper that converts the model’s output into a form that is torch-jit-traceable. You can then compile the wrapped model for Inferentia using [`torch_neuron.trace()`](api-compilation-python-api.html#torch_neuron.trace "torch_neuron.trace"). The following example uses a wrapper to compile a model with non torch-jit-traceable outputs. This model cannot be compiled for Inferentia in its current form because it outputs a list of tuples and tensors, which is not torch-jit-traceable. ``` import torch import torch_neuron import torch.nn as nn class Model(nn.Module): def __init__(self): super(Model, self).__init__() self.conv = nn.Conv2d(1, 1, 3) def forward(self, x): a = self.conv(x) + 1 b = self.conv(x) + 2 c = self.conv(x) + 3 # An output that is a list of tuples and tensors is not torch-traceable return [(a, b), c] model = Model() model.eval() inputs = torch.rand(1, 1, 3, 3) # Try to compile the model model_neuron = torch.neuron.trace(model, inputs) # ERROR: This cannot be traced, we must change the output format ``` To compile this model for Inferentia, we can write a wrapper around the model to convert its outputs into a tuple of tensors, which is torch-jit-traceable. ``` class NeuronCompatibilityWrapper(nn.Module): def __init__(self): super(NeuronCompatibilityWrapper, self).__init__() self.model = Model() def forward(self, x): out = self.model(x) # An output that is a tuple of tuples and tensors is torch-jit-traceable return tuple(out) ``` Now, we can successfully compile the model for Inferentia using the `NeuronCompatibilityWrapper` wrapper as follows: ``` model = NeuronCompatibilityWrapper() model.eval() # Compile the traceable wrapped model model_neuron = torch.neuron.trace(model, inputs) ``` If the model’s outputs must be in the original form, a second wrapper can be used to transform the outputs after compilation for Inferentia. The following example uses the `OutputFormatWrapper` wrapper to convert the compiled model’s output back into the original form of a list of tuples and tensors. ``` class OutputFormatWrapper(nn.Module): def __init__(self): super(OutputFormatWrapper, self).__init__() self.traceable_model = NeuronCompatibilityWrapper() def forward(self, x): out = self.traceable_model(x) # Return the output in the original format of Model() return list(out) model = OutputFormatWrapper() model.eval() # Compile the traceable wrapped model model.traceable_model = torch.neuron.trace(model.traceable_model, inputs) ``` ### Compiling a submodule in a model that is not torch-jit-traceable[#](#compiling-a-submodule-in-a-model-that-is-not-torch-jit-traceable "Permalink to this headline") The following example shows how to compile a submodule that is part of a non torch-jit-traceable model. In this example, the top-level model `Outer` uses a dynamic flag, which is not torch-jit-traceable. However, the submodule `Inner` is torch-jit-traceable and can be compiled for Inferentia. ``` import torch import torch_neuron import torch.nn as nn class Inner(nn.Module) : def __init__(self): super().__init__() self.conv = nn.Conv2d(1, 1, 3) def forward(self, x): return self.conv(x) + 1 class Outer(nn.Module): def __init__(self): super().__init__() self.inner = Inner() def forward(self, x, add_offset: bool = False): base = self.inner(x) if add_offset: return base + 1 return base model = Outer() inputs = torch.rand(1, 1, 3, 3) # Compile the traceable wrapped submodule model.inner = torch.neuron.trace(model.inner, inputs) # TorchScript the model for serialization script = torch.jit.script(model) torch.jit.save(script, 'model.pt') loaded = torch.jit.load('model.pt') ``` Alternatively, for usage scenarios in which the model configuration is static during inference, the dynamic flags can be hardcoded in a wrapper to make the model torch-jit-traceable and enable compiling the entire model for Inferentia. In this example, we assume the `add_offset` flag is always `True` during inference, so we can hardcode this conditional path in the `Static` wrapper to remove the dynmaic behavior and compile the entire model for Inferentia. ``` class Static(nn.Module): def __init__(self): super().__init__() self.outer = Outer() def forward(self, x): # hardcode `add_offset=True` output = self.outer(x, add_offset=True) return output model = Static() # We can now compile the entire model because `add_offset=True` is hardcoded in the Static wrapper model_neuron = torch.neuron.trace(model, inputs) ``` _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Troubleshooting Guide for PyTorch Neuron (torch-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuron) release notes" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> <link rel="prev" title="PyTorch Neuron (torch-neuron) Supported operators" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuron/troubleshooting-guide", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="misc-inference-torch-neuron.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuron/troubleshooting-guide.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuron/troubleshooting-guide.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuron/troubleshooting-guide.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#general-torch-neuron-issues"> General Torch-Neuron issues </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#torchvision-related-issues"> TorchVision related issues </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#gb-protobuf-limit-related-issues"> 2GB protobuf limit related issues </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-jit-trace-issues"> torch.jit.trace issues </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compiling-models-with-outputs-that-are-not-torch-jit-traceable"> Compiling models with outputs that are not torch-jit-traceable </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compiling-a-submodule-in-a-model-that-is-not-torch-jit-traceable"> Compiling a submodule in a model that is not torch-jit-traceable </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Troubleshooting Guide for PyTorch Neuron (torch-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#general-torch-neuron-issues"> General Torch-Neuron issues </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#torchvision-related-issues"> TorchVision related issues </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#gb-protobuf-limit-related-issues"> 2GB protobuf limit related issues </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#torch-jit-trace-issues"> torch.jit.trace issues </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compiling-models-with-outputs-that-are-not-torch-jit-traceable"> Compiling models with outputs that are not torch-jit-traceable </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compiling-a-submodule-in-a-model-that-is-not-torch-jit-traceable"> Compiling a submodule in a model that is not torch-jit-traceable </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="troubleshooting-guide-for-pytorch-neuron-torch-neuron"> <span id="pytorch-neuron-inference-troubleshooting"></span><h1>Troubleshooting Guide for PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)<a class="headerlink" href="#troubleshooting-guide-for-pytorch-neuron-torch-neuron" title="Permalink to this headline">#</a></h1> <div class="section" id="general-torch-neuron-issues"> <h2>General Torch-Neuron issues<a class="headerlink" href="#general-torch-neuron-issues" title="Permalink to this headline">#</a></h2> <p>If you see an error about “Unknown builtin op: neuron::forward_1” like below, please ensure that import line “import torch_neuron” (to register the Neuron custom operation) is in the inference script before using torch.jit.load.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Unknown</span> <span class="n">builtin</span> <span class="n">op</span><span class="p">:</span> <span class="n">neuron</span><span class="p">::</span><span class="n">forward_1</span><span class="o">.</span> <span class="n">Could</span> <span class="ow">not</span> <span class="n">find</span> <span class="nb">any</span> <span class="n">similar</span> <span class="n">ops</span> <span class="n">to</span> <span class="n">neuron</span><span class="p">::</span><span class="n">forward_1</span><span class="o">.</span> <span class="n">This</span> <span class="n">op</span> <span class="n">may</span> <span class="ow">not</span> <span class="n">exist</span> <span class="ow">or</span> <span class="n">may</span> <span class="ow">not</span> <span class="n">be</span> <span class="n">currently</span> <span class="n">supported</span> <span class="ow">in</span> <span class="n">TorchScript</span><span class="o">.</span> </pre></div> </div> </div> <div class="section" id="torchvision-related-issues"> <h2>TorchVision related issues<a class="headerlink" href="#torchvision-related-issues" title="Permalink to this headline">#</a></h2> <p>If you encounter an error like below, it is because latest torchvision version &gt;= 0.7 is not compatible with Torch-Neuron 1.5.1. Please downgrade torchvision to version 0.6.1:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">E</span> <span class="ne">AttributeError</span><span class="p">:</span> <span class="n">module</span> <span class="s1">'torch.jit'</span> <span class="n">has</span> <span class="n">no</span> <span class="n">attribute</span> <span class="s1">'_script_if_tracing'</span> </pre></div> </div> </div> <div class="section" id="gb-protobuf-limit-related-issues"> <h2>2GB protobuf limit related issues<a class="headerlink" href="#gb-protobuf-limit-related-issues" title="Permalink to this headline">#</a></h2> <p>If you encounter an error like below, it is because the model size is larger than 2GB. To compile such large models, use the <a class="reference internal" href="api-compilation-python-api.html#torch-neuron-trace-api"><span class="std std-ref">separate_weights=True</span></a> flag. Note, ensure that you have the latest version of compiler installed to support this flag. You can upgrade neuron-cc using <code class="code docutils literal notranslate"><span class="pre">python3</span> <span class="pre">-m</span> <span class="pre">pip</span> <span class="pre">install</span> <span class="pre">neuron-cc[tensorflow]</span> <span class="pre">-U</span> <span class="pre">--force</span> <span class="pre">--extra-index-url=https://pip.repos.neuron.amazonaws.com</span></code></p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">E</span> <span class="n">google</span><span class="o">.</span><span class="n">protobuf</span><span class="o">.</span><span class="n">message</span><span class="o">.</span><span class="n">DecodeError</span><span class="p">:</span> <span class="n">Error</span> <span class="n">parsing</span> <span class="n">message</span> <span class="k">with</span> <span class="nb">type</span> <span class="s1">'tensorflow.GraphDef'</span> </pre></div> </div> </div> <div class="section" id="torch-jit-trace-issues"> <h2>torch.jit.trace issues<a class="headerlink" href="#torch-jit-trace-issues" title="Permalink to this headline">#</a></h2> <p>The <span class="xref std std-ref">/neuron-guide/neuron-frameworks/pytorch-neuron/api-compilation-python-api.rst</span> uses the PyTorch <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a> function to generate <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.ScriptModule.html#torch.jit.ScriptModule" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptModule</span></code></a> models for execution on Inferentia. Due to that, to execute your PyTorch model on Inferentia it must be torch-jit-traceable, otherwise you need to make sure your model is torch-jit-traceable. You can try modifying your underlying PyTorch model code to make it traceable. If it’s not possible to change your model code, you can <a class="reference internal" href="#wrapping-non-traceable-models"><span class="std std-ref">write a wrapper around your model</span></a> that makes it torch-jit-traceable to compile it for Inferentia.</p> <p>Please visit <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a> to review the properties that a model must have to be torch-jit-traceable. The PyTorch-Neuron trace API <a class="reference internal" href="api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> accepts <code class="code docutils literal notranslate"><span class="pre">**kwargs</span></code> for <a class="reference external" href="https://pytorch.org/docs/master/generated/torch.jit.trace.html#torch.jit.trace" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code></a>. For example, you can use the <code class="code docutils literal notranslate"><span class="pre">strict=False</span></code> flag to <a class="reference internal" href="api-compilation-python-api.html#compiling-models-with-kwargs"><span class="std std-ref">compile models with dictionary outputs</span></a>.</p> <div class="section" id="compiling-models-with-outputs-that-are-not-torch-jit-traceable"> <span id="wrapping-non-traceable-models"></span><h3>Compiling models with outputs that are not torch-jit-traceable<a class="headerlink" href="#compiling-models-with-outputs-that-are-not-torch-jit-traceable" title="Permalink to this headline">#</a></h3> <p>To enable compilation of models with non torch-jit-traceable outputs, you can use a technique that involves writing a wrapper that converts the model’s output into a form that is torch-jit-traceable. You can then compile the wrapped model for Inferentia using <a class="reference internal" href="api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a>.</p> <p>The following example uses a wrapper to compile a model with non torch-jit-traceable outputs. This model cannot be compiled for Inferentia in its current form because it outputs a list of tuples and tensors, which is not torch-jit-traceable.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">(</span><span class="n">Model</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="n">a</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="n">b</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">2</span> <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">3</span> <span class="c1"># An output that is a list of tuples and tensors is not torch-traceable</span> <span class="k">return</span> <span class="p">[(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">),</span> <span class="n">c</span><span class="p">]</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Model</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c1"># Try to compile the model</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">inputs</span><span class="p">)</span> <span class="c1"># ERROR: This cannot be traced, we must change the output format</span> </pre></div> </div> <p>To compile this model for Inferentia, we can write a wrapper around the model to convert its outputs into a tuple of tensors, which is torch-jit-traceable.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">NeuronCompatibilityWrapper</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">(</span><span class="n">NeuronCompatibilityWrapper</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span> <span class="o">=</span> <span class="n">Model</span><span class="p">()</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="c1"># An output that is a tuple of tuples and tensors is torch-jit-traceable</span> <span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">out</span><span class="p">)</span> </pre></div> </div> <p>Now, we can successfully compile the model for Inferentia using the <code class="code docutils literal notranslate"><span class="pre">NeuronCompatibilityWrapper</span></code> wrapper as follows:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">model</span> <span class="o">=</span> <span class="n">NeuronCompatibilityWrapper</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile the traceable wrapped model</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">inputs</span><span class="p">)</span> </pre></div> </div> <p>If the model’s outputs must be in the original form, a second wrapper can be used to transform the outputs after compilation for Inferentia. The following example uses the <code class="code docutils literal notranslate"><span class="pre">OutputFormatWrapper</span></code> wrapper to convert the compiled model’s output back into the original form of a list of tuples and tensors.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">OutputFormatWrapper</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">(</span><span class="n">OutputFormatWrapper</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">traceable_model</span> <span class="o">=</span> <span class="n">NeuronCompatibilityWrapper</span><span class="p">()</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">traceable_model</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="c1"># Return the output in the original format of Model()</span> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">out</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">OutputFormatWrapper</span><span class="p">()</span> <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span> <span class="c1"># Compile the traceable wrapped model</span> <span class="n">model</span><span class="o">.</span><span class="n">traceable_model</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">traceable_model</span><span class="p">,</span> <span class="n">inputs</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="compiling-a-submodule-in-a-model-that-is-not-torch-jit-traceable"> <h3>Compiling a submodule in a model that is not torch-jit-traceable<a class="headerlink" href="#compiling-a-submodule-in-a-model-that-is-not-torch-jit-traceable" title="Permalink to this headline">#</a></h3> <p>The following example shows how to compile a submodule that is part of a non torch-jit-traceable model. In this example, the top-level model <code class="code docutils literal notranslate"><span class="pre">Outer</span></code> uses a dynamic flag, which is not torch-jit-traceable. However, the submodule <code class="code docutils literal notranslate"><span class="pre">Inner</span></code> is torch-jit-traceable and can be compiled for Inferentia.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuron</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="k">class</span> <span class="nc">Inner</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">)</span> <span class="p">:</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Conv2d</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conv</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="k">class</span> <span class="nc">Outer</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">inner</span> <span class="o">=</span> <span class="n">Inner</span><span class="p">()</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">add_offset</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span> <span class="n">base</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">inner</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">if</span> <span class="n">add_offset</span><span class="p">:</span> <span class="k">return</span> <span class="n">base</span> <span class="o">+</span> <span class="mi">1</span> <span class="k">return</span> <span class="n">base</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Outer</span><span class="p">()</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c1"># Compile the traceable wrapped submodule</span> <span class="n">model</span><span class="o">.</span><span class="n">inner</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">inner</span><span class="p">,</span> <span class="n">inputs</span><span class="p">)</span> <span class="c1"># TorchScript the model for serialization</span> <span class="n">script</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">script</span><span class="p">(</span><span class="n">model</span><span class="p">)</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">script</span><span class="p">,</span> <span class="s1">'model.pt'</span><span class="p">)</span> <span class="n">loaded</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">jit</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'model.pt'</span><span class="p">)</span> </pre></div> </div> <p>Alternatively, for usage scenarios in which the model configuration is static during inference, the dynamic flags can be hardcoded in a wrapper to make the model torch-jit-traceable and enable compiling the entire model for Inferentia. In this example, we assume the <code class="code docutils literal notranslate"><span class="pre">add_offset</span></code> flag is always <code class="code docutils literal notranslate"><span class="pre">True</span></code> during inference, so we can hardcode this conditional path in the <code class="code docutils literal notranslate"><span class="pre">Static</span></code> wrapper to remove the dynmaic behavior and compile the entire model for Inferentia.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Static</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">outer</span> <span class="o">=</span> <span class="n">Outer</span><span class="p">()</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="c1"># hardcode `add_offset=True`</span> <span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">outer</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">add_offset</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">return</span> <span class="n">output</span> <span class="n">model</span> <span class="o">=</span> <span class="n">Static</span><span class="p">()</span> <span class="c1"># We can now compile the entire model because `add_offset=True` is hardcoded in the Static wrapper</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">neuron</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">inputs</span><span class="p">)</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) Supported operators</p> </div> </a> <a class="right-next" id="next-link" href="../../../release-notes/torch/torch-neuron/torch-neuron.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) release notes</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:01.951Z
Training (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/training-torch-neuronx.html
# Training (torch-neuronx) — AWS Neuron Documentation previous PyTorch Neuron (`torch-neuron`) release notes
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Training (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Tutorials for Training(torch-neuronx)" href="torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> <link rel="prev" title="PyTorch Neuron (torch-neuron) release notes" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/training-torch-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> </head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="current reference internal" href="#"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/training-torch-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/training-torch-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/torch/training-torch-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Training (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="training-torch-neuronx"> <span id="id1"></span><h1>Training (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#training-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Setup (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</div> </div> <a class="sd-stretched-link reference internal" href="../../general/setup/torch-neuronx.html#setup-torch-neuronx"><span class="std std-ref"></span></a></div> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Tutorials<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/tutorials/training/bert.html#hf-bert-pretraining-tutorial"><span class="std std-ref">Hugging Face BERT Pretraining Tutorial</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/tutorials/training/mlp.html#neuronx-mlp-training-tutorial"><span class="std std-ref">Multi-Layer Perceptron Training Tutorial</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/tutorials/training/finetune_hftrainer.html#torch-hf-bert-finetune"><span class="std std-ref">PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/tutorials/training/finetune_t5.html#torch-hf-t5-finetune"><span class="std std-ref">Fine-tune T5 model on Trn1</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/tutorials/training/zero1_gpt2.html#zero1-gpt2-pretraining-tutorial"><span class="std std-ref">ZeRO-1 Tutorial</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/tutorials/training/analyze_for_training.html#torch-analyze-for-training-tutorial"><span class="std std-ref">Analyze for Training Tutorial</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html#neuronx-customop-mlp-tutorial"><span class="std std-ref">Neuron Custom C++ Operators in MLP Training</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html#neuronx-customop-mlp-perf"><span class="std std-ref">Neuron Custom C++ Operators Performance Optimization</span></a></p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p class="sd-card-text">To use Jupyter Notebook see:</p> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Additional Examples<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron">AWS Neuron Reference for Nemo Megatron GitHub Repository</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples">AWS Neuron Samples for EKS</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples">AWS Neuron Samples for AWS ParallelCluster</a></p></li> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training">AWS Neuron Samples GitHub Repository</a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> API Reference Guide<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">PyTorch Neuron neuron_parallel_compile CLI (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html#pytorch-neuronx-envvars"><span class="std std-ref">PyTorch Neuron Environment Variables (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html#torch-neuronx-profiling-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Profiling API</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Developer Guide<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html#pytorch-neuronx-programming-guide"><span class="std std-ref">Developer Guide for Training with PyTorch Neuron (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/programming-guide/training/pytorch-neuron-debug.html#pytorch-neuronx-debug"><span class="std std-ref">How to debug models in PyTorch Neuron (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html#torch-neuronx-dev-guide"><span class="std std-ref">Developer Guide for Profiling with PyTorch Neuron (torch-neuronx)</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Misc<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators"><span class="std std-ref">PyTorch Neuron (torch-neuronx) - Supported Operators</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/setup-trn1-multi-node-execution.html#setup-trn1-multi-node-execution"><span class="std std-ref">How to prepare trn1.32xlarge for multi-node execution</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuronx/training-troubleshooting.html#pytorch-neuron-traning-troubleshooting"><span class="std std-ref">PyTorch Neuron (torch-neuronx) for Training Troubleshooting Guide</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html#torch-neuronx-rn"><span class="std std-ref">PyTorch Neuron (torch-neuronx) release notes</span></a></p></li> </ul> </div> </details><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../release-notes/torch/torch-neuron/torch-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) release notes</p> </div> </a> <a class="right-next" id="next-link" href="torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Tutorials for Training(torch-neuronx)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:02.858Z
PyTorch Neuron (torch-neuron) release notes — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/release-notes/torch/torch-neuron/torch-neuron.html
# PyTorch Neuron (torch-neuron) release notes — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## PyTorch Neuron (`torch-neuron`) release notes[#](#pytorch-neuron-torch-neuron-release-notes "Permalink to this headline") Table of contents - [Known Issues and Limitations - Updated 03/21/2023](#known-issues-and-limitations-updated-03-21-2023) - [PyTorch Neuron release \[package ver. 1.\*.\*.2.9.1.0, SDK ver. 2.13.0\]](#pytorch-neuron-release-package-ver-1-2-9-1-0-sdk-ver-2-13-0) - [PyTorch Neuron release \[package ver. 1.\*.\*.2.8.9.0, SDK ver. 2.12.0\]](#pytorch-neuron-release-package-ver-1-2-8-9-0-sdk-ver-2-12-0) - [PyTorch Neuron release \[2.7.10.0\]](#pytorch-neuron-release-2-7-10-0) - [PyTorch Neuron release \[2.7.1.0\]](#pytorch-neuron-release-2-7-1-0) - [PyTorch Neuron release \[2.6.5.0\]](#pytorch-neuron-release-2-6-5-0) - [PyTorch Neuron release \[2.5.0.0\]](#pytorch-neuron-release-2-5-0-0) - [PyTorch Neuron release \[2.3.0.0\]](#pytorch-neuron-release-2-3-0-0) - [PyTorch Neuron release \[2.2.0.0\]](#pytorch-neuron-release-2-2-0-0) - [PyTorch Neuron release \[2.1.7.0\]](#pytorch-neuron-release-2-1-7-0) - [PyTorch Neuron release \[2.0.536.0\]](#pytorch-neuron-release-2-0-536-0) - [PyTorch Neuron release \[2.0.468.0\]](#pytorch-neuron-release-2-0-468-0) - [PyTorch Neuron release \[2.0.392.0\]](#pytorch-neuron-release-2-0-392-0) - [PyTorch Neuron release \[2.0.318.0\]](#pytorch-neuron-release-2-0-318-0) - [\[1.8.1.1.5.21.0\]](#id13) - [\[1.8.1.1.5.7.0\]](#neuron-torch-1570) - [\[1.8.1.1.4.1.0\]](#neuron-torch-1410) - [\[1.7.1.1.3.5.0\]](#neuron-torch-1350) - [\[1.7.1.1.2.16.0\]](#neuron-torch-12160) - [\[1.7.1.1.2.15.0\]](#neuron-torch-12150) - [\[1.7.1.1.2.3.0\]](#neuron-torch-1230) - [\[1.1.7.0\]](#neuron-torch-11170) - [\[1.0.1978.0\]](#neuron-torch-1019780) - [\[1.0.1721.0\]](#neuron-torch-1017210) - [\[1.0.1532.0\]](#neuron-torch-1015320) - [\[1.0.1522.0\]](#neuron-torch-1015220) - [\[1.0.1386.0\]](#neuron-torch-1013860) - [\[1.0.1168.0\]](#neuron-torch-1011680) - [\[1.0.1001.0\]](#neuron-torch-1010010) - [\[1.0.825.0\]](#neuron-torch-108250) - [\[1.0.763.0\]](#neuron-torch-107630) - [\[1.0.672.0\]](#neuron-torch-106720) - [\[1.0.627.0\]](#neuron-torch-106270) This document lists the release notes for the Pytorch-Neuron package. ## [Known Issues and Limitations - Updated 03/21/2023](#id70)[#](#known-issues-and-limitations-updated-03-21-2023 "Permalink to this headline") ### Min & Max Accuracy[#](#min-max-accuracy "Permalink to this headline") The index outputs of the `aten::argmin`, `aten::argmax`, `aten::min`, and `aten::max` operator implementations are sensitive to precision. For models that contain these operators and have `float32` inputs, we recommend using the `--fp32-cast=matmult --fast-math no-fast-relayout` compiler option to avoid numerical imprecision issues. Additionally, the `aten::min` and `aten::max` operator implementations do not currently support `int64` inputs when `dim=0`. For more information on precision and performance-accuracy tuning, see [Mixed precision and performance-accuracy tuning (neuron-cc)](../../../general/appnotes/neuron-cc/mixed-precision.html#neuron-cc-training-mixed-precision). ### Python 3.5[#](#python-3-5 "Permalink to this headline") If you attempt to import torch.neuron from Python 3.5 you will see this error in 1.1.7.0 - please use Python 3.6 or greater: ``` File "/tmp/install_test_env/lib/python3.5/site-packages/torch_neuron/__init__.py", line 29 f'Invalid dependency version torch=={torch.__version__}. ' ^ SyntaxError: invalid syntax ``` - Torchvision has dropped support for Python 3.5 - HuggingFace transformers has dropped support for Python 3.5 ### Torchvision[#](#torchvision "Permalink to this headline") When versions of `torchvision` and `torch` are mismatched, this can result in exceptions when compiling `torchvision` based models. Specific versions of `torchvision` are built against each release of `torch`. For example: - `torch==1.5.1` matches `torchvision==0.6.1` - `torch==1.7.1` matches `torchvision==0.8.2` - etc. Simultaneously installing both `torch-neuron` and `torchvision` is the recommended method of correctly resolving versions. ### Dynamic Batching[#](#dynamic-batching "Permalink to this headline") Dynamic batching does not work properly for some models that use the `aten::size` operator. When this issue occurs, the input batch sizes are not properly recorded at inference time, resulting in an error such as: ``` RuntimeError: The size of tensor a (X) must match the size of tensor b (Y) at non-singleton dimension 0. ``` This error typically occurs when `aten::size` operators are partitioned to CPU. We are investigating a fix for this issue. ## [PyTorch Neuron release \[package ver. 1.\*.\*.2.9.1.0, SDK ver. 2.13.0\]](#id71)[#](#pytorch-neuron-release-package-ver-1-2-9-1-0-sdk-ver-2-13-0 "Permalink to this headline") Date: 8/28/2023 - Added support for clamp\_min/clamp\_max ATEN operators. ## [PyTorch Neuron release \[2.7.10.0\]](#id73)[#](#pytorch-neuron-release-2-7-10-0 "Permalink to this headline") Date: 6/14/2023 ### New in this release[#](#new-in-this-release "Permalink to this headline") - Added support for Python 3.10 ### Bug fixes[#](#bug-fixes "Permalink to this headline") - torch.pow Operation now correctly handles mismatch between base and exponent data types ## [PyTorch Neuron release \[2.7.1.0\]](#id74)[#](#pytorch-neuron-release-2-7-1-0 "Permalink to this headline") Date: 05/1/2023 - Minor updates. ## [PyTorch Neuron release \[2.6.5.0\]](#id75)[#](#pytorch-neuron-release-2-6-5-0 "Permalink to this headline") Date: 03/28/2023 ### New in this release[#](#id1 "Permalink to this headline") - Added support for `torch==1.13.1` - New releases of `torch-neuron` no longer include versions for `torch==1.7` and `torch==1.8` - Added support for Neuron runtime 2.12 - Added support for new operators: - `aten::tensordot` - `aten::adaptive_avg_pool1d` - `aten::prelu` - `aten::reflection_pad2d` - `aten::baddbmm` - `aten::repeat` - Added a `separate_weights` flag to [`torch_neuron.trace()`](../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace "torch_neuron.trace") to support models that are larger than 2GB ### Bug fixes[#](#id2 "Permalink to this headline") - Fixed `aten::_convolution` with grouping for: - [`torch.nn.Conv1d`](https://pytorch.org/docs/master/generated/torch.nn.Conv1d.html#torch.nn.Conv1d "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") - [`torch.nn.Conv3d`](https://pytorch.org/docs/master/generated/torch.nn.Conv3d.html#torch.nn.Conv3d "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") - [`torch.nn.ConvTranspose2d`](https://pytorch.org/docs/master/generated/torch.nn.ConvTranspose2d.html#torch.nn.ConvTranspose2d "(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))") - Fixed `aten::linear` to support 1d input tensors - Fixed an issue where an input could not be directly returned from the network ## [PyTorch Neuron release \[2.5.0.0\]](#id76)[#](#pytorch-neuron-release-2-5-0-0 "Permalink to this headline") Date: 11/23/2022 ### New in this release[#](#id3 "Permalink to this headline") - Added PyTorch 1.12 support - Added Python 3.8 support - Added new operators support. See [PyTorch Neuron (torch-neuron) Supported operators](../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch) - Added support for `aten::lstm`. See: [Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support](../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html#torch-neuron-lstm-support) - Improved logging: - Improved error messages for specific compilation failure modes, including out-of-memory errors - Added a warning to show the code location of `prim::PythonOp` operations - Removed overly-verbose tracing messages - Added improved error messages for `neuron-cc` and `tensorflow` dependency issues - Added more debug information when an invalid dynamic batching configuration is used - Added new experimental explicit NeuronCore placement API. See: torch\_neuron\_core\_placement\_api - Added new guide for NeuronCore placement. See: [PyTorch Neuron (torch-neuron) Core Placement](../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html#torch-neuron-core-placement-guide) - Improved [`torch_neuron.trace()`](../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace "torch_neuron.trace") performance when using large graphs - Reduced host memory usage of loaded models in `libtorchneuron.so` - Added `single_fusion_ratio_threshold` argument to [`torch_neuron.trace()`](../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace "torch_neuron.trace") to give more fine-grained control of partitioned graphs ### Bug fixes[#](#id4 "Permalink to this headline") - Improved handling of tensor mutations which previously caused accuracy issues on certain models (i.e. yolor, yolov5) - Fixed an issue where `inf` and `-inf` values would cause unexpected `NaN` values. This could occur with newer versions of `transformers` - Fixed an issue where [`torch.neuron.DataParallel()`](../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel "torch.neuron.DataParallel") would not fully utilize all NeuronCores for specific batch sizes - Fixed and improved operators: - `aten::upsample_bilinear2d`: Improved error messages in cases where the operation cannot be supported - `aten::_convolution`: Added support for `output_padding` argument - `aten::div`: Added support for `rounding_mode` argument - `aten::sum`: Fixed to handle non-numeric data types - `aten::expand`: Fixed to handle scalar tensors - `aten::permute`: Fixed to handle negative indices - `aten::min`: Fixed to support more input types - `aten::max`: Fixed to support more input types - `aten::max_pool2d`: Fixed to support both 3-dimensional and 4-dimensional input tensors - `aten::Int`: Fixed an issue where long values would incorrectly lose precision - `aten::constant_pad_nd`: Fixed to correctly use non-0 padding values - `aten::pow`: Fixed to support more input types & values - `aten::avg_pool2d`: Added support for `count_include_pad` argument. Added support for `ceil_mode` argument if padding isn’t specified - `aten::zero`: Fixed to handle scalars correctly - `prim::Constant`: Fixed an issue where `-inf` was incorrectly handled - Improved handling of scalars in arithmetic operators ## [PyTorch Neuron release \[2.3.0.0\]](#id77)[#](#pytorch-neuron-release-2-3-0-0 "Permalink to this headline") Date: 04/29/2022 ### New in this release[#](#id5 "Permalink to this headline") - Added support PyTorch 1.11. - Updated PyTorch 1.10 to version 1.10.2. - End of support for torch-neuron 1.5, see [End of support for torch-neuron version 1.5](../../../general/announcements/neuron1.x/eol-pt-15.html#eol-pt-15). - Added support for new operators: - `aten::masked_fill_` - `aten::new_zeros` - `aten::frobenius_norm` ### Bug fixes[#](#id6 "Permalink to this headline") - Improved `aten::gelu` accuracy - Updated `aten::meshgrid` to support optional indexing argument introduced in `torch 1.10` , see [PyTorch issue 50276](https://github.com/pytorch/pytorch/issues/50276) ## [PyTorch Neuron release \[2.2.0.0\]](#id78)[#](#pytorch-neuron-release-2-2-0-0 "Permalink to this headline") Date: 03/25/2022 ### New in this release[#](#id7 "Permalink to this headline") - Added full support for `aten::max_pool2d_with_indices` - (Was previously supported only when indices were unused). - Added new torch-neuron packages compiled with `-D_GLIBCXX_USE_CXX11_ABI=1`, the new packages support PyTorch 1.8, PyTorch 1.9, and PyTorch 1.10. To install the additional packages compiled with `-D_GLIBCXX_USE_CXX11_ABI=1` please change the package repo index to `https://pip.repos.neuron.amazonaws.com (https://pip.repos.neuron.amazonaws.com/)/cxx11/` ## [PyTorch Neuron release \[2.1.7.0\]](#id79)[#](#pytorch-neuron-release-2-1-7-0 "Permalink to this headline") Date: 01/20/2022 ### New in this release[#](#id8 "Permalink to this headline") - Added PyTorch 1.10 support - Added new operators support, see [PyTorch Neuron (torch-neuron) Supported operators](../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch) - Updated `aten::_convolution` to support 2d group convolution - Updated `neuron::forward` operators to allocate less dynamic memory. This can increase performance on models with many input & output tensors. - Updated `neuron::forward` to better handle batch sizes when `dynamic_batch_size=True`. This can increase performance at inference time when the input batch size is exactly equal to the traced model batch size. ### Bug fixes[#](#id9 "Permalink to this headline") - Added the ability to `torch.jit.trace` a `torch.nn.Module` where a submodule has already been traced with [`torch_neuron.trace()`](../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace "torch_neuron.trace") on a CPU-type instance. Previously, if this had been executed on a CPU-type instance, an initialization exception would have been thrown. - Fixed `aten::matmul` behavior on 1-dimensional by n-dimensional multiplies. Previously, this would cause a validation error. - Fixed binary operator type promotion. Previously, in unusual situations, operators like `aten::mul` could produce incorrect results due to invalid casting. - Fixed `aten::select` when index was -1. Previously, this would cause a validation error. - Fixed `aten::adaptive_avg_pool2d` padding and striding behavior. Previously, this could generate incorrect results with specific configurations. - Fixed an issue where dictionary inputs could be incorrectly traced when the tensor values had gradients. ## [PyTorch Neuron release \[2.0.468.0\]](#id81)[#](#pytorch-neuron-release-2-0-468-0 "Permalink to this headline") Date: 12/15/2021 ### New in this release[#](#id11 "Permalink to this headline") - Added support for `aten::cumsum` operation. - Fixed `aten::expand` to correctly handle adding new dimensions. ## [PyTorch Neuron release \[2.0.392.0\]](#id82)[#](#pytorch-neuron-release-2-0-392-0 "Permalink to this headline") Date: 11/05/2021 - Updated Neuron Runtime (which is integrated within this package) to `libnrt 2.2.18.0` to fix a container issue that was preventing the use of containers when /dev/neuron0 was not present. See details here neuron-runtime-release-notes. ## [PyTorch Neuron release \[2.0.318.0\]](#id83)[#](#pytorch-neuron-release-2-0-318-0 "Permalink to this headline") Date: 10/27/2021 ### New in this release[#](#id12 "Permalink to this headline") - PyTorch Neuron 1.x now support Neuron Runtime 2.x (`libnrt.so` shared library) only. Important - You must update to the latest Neuron Driver (`aws-neuron-dkms` version 2.1 or newer) for proper functionality of the new runtime library. - Read [Introducing Neuron Runtime 2.x (libnrt.so)](../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt) application note that describes [why are we making this change](../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-why) and how [this change will affect the Neuron SDK](../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-how-sdk) in detail. - Read [Migrate your application to Neuron Runtime 2.x (libnrt.so)](../../../general/appnotes/neuron1x/introducing-libnrt.html#neuron-migrating-apps-neuron-to-libnrt) for detailed information of how to migrate your application. - Introducing PyTorch 1.9.1 support (support for `torch==1.9.1)` - Added `torch_neuron.DataParallel`, see ResNet-50 tutorial [\[html\]](../../../src/examples/pytorch/resnet50.html) and [Data Parallel Inference on Torch Neuron](../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html#torch-neuron-dataparallel-app-note) application note. - Added support for tracing on GPUs - Added support for `ConvTranspose1d` - Added support for new operators: - `aten::empty_like` - `aten::log` - `aten::type_as` - `aten::movedim` - `aten::einsum` - `aten::argmax` - `aten::min` - `aten::argmin` - `aten::abs` - `aten::cos` - `aten::sin` - `aten::linear` - `aten::pixel_shuffle` - `aten::group_norm` - `aten::_weight_norm` - Added `torch_neuron.is_available()` ### Resolved Issues[#](#resolved-issues "Permalink to this headline") - Fixed a performance issue when using both the `dynamic_batch_size=True` trace option and `--neuron-core-pipeline` compiler option. Dynamic batching now uses `OpenMP` to execute pipeline batches concurrently. - Fixed `torch_neuron.trace` issues: - Fixed a failure when the same submodule was traced with multiple inputs - Fixed a failure where some operations would fail to be called with the correct arguments - Fixed a failure where custom operators (torch plugins) would cause a trace failure - Fixed variants of `aten::upsample_bilinear2d` when `scale_factor=1` - Fixed variants of `aten::expand` using `dim=-1` - Fixed variants of `aten::stack` using multiple different input data types - Fixed variants of `aten::max` using indices outputs ## [\[1.8.1.1.5.21.0\]](#id84)[#](#id13 "Permalink to this headline") Date: 08/12/2021 ## [\[1.8.1.1.5.7.0\]](#id85)[#](#neuron-torch-1570 "Permalink to this headline") Date: 07/02/2021 ### Summary[#](#id15 "Permalink to this headline") - Added support for dictionary outputs using `strict=False` flag. See /neuron-guide/neuron-frameworks/pytorch-neuron/troubleshooting-guide.rst. - Updated `aten::batch_norm` to correctly implement the `affine` flag. - Added support for `aten::erf` and `prim::DictConstruct`. See [PyTorch Neuron (torch-neuron) Supported operators](../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch). - Added dynamic batch support. See /neuron-guide/neuron-frameworks/pytorch-neuron/api-compilation-python-api.rst. ## [\[1.8.1.1.4.1.0\]](#id86)[#](#neuron-torch-1410 "Permalink to this headline") Date: 5/28/2021 ### Summary[#](#id17 "Permalink to this headline") - Added support for PyTorch 1.8.1 - Models compatibility - Models compiled with previous versions of PyTorch Neuron (<1.8.1) are compatible with PyTorch Neuron 1.8.1. - Models compiled with PyTorch Neuron 1.8.1 are not backward compatible with previous versions of PyTorch Neuron (<1.8.1) . - Updated tutorials to use Hugging Face Transformers 4.6.0. - Added a new set of forward operators (forward\_v2) - Host memory allocation when loading the same model on multiple NeuronCores is significantly reduced - Fixed an issue where models would not deallocate all memory within a python session after being garbage collected. - Fixed a TorchScript/C++ issue where loading the same model multiple times would not use multiple NeuronCores by default. - Fixed logging to no longer configure the root logger. - Removed informative messages that were produced during compilations as warnings. The number of warnings reduced significantly. - Convolution operator support has been extended to include ConvTranspose2d variants. - Reduce the amount of host memory usage during inference. ## [\[1.7.1.1.3.5.0\]](#id87)[#](#neuron-torch-1350 "Permalink to this headline") Date: 4/30/2021 ### Summary[#](#id19 "Permalink to this headline") - ResNext models now functional with new operator support - Yolov5 support refer to [https://github.com/aws/aws-neuron-sdk/issues/253](https://github.com/aws/aws-neuron-sdk/issues/253) note [https://github.com/ultralytics/yolov5/pull/2953](https://github.com/ultralytics/yolov5/pull/2953) which optimized YoloV5 for AWS Neuron - Convolution operator support has been extended to include most Conv1d and Conv3d variants - New operator support. Please see [PyTorch Neuron (torch-neuron) Supported operators](../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch) for the complete list of operators. ## [\[1.7.1.1.2.16.0\]](#id88)[#](#neuron-torch-12160 "Permalink to this headline") Date: 3/4/2021 ### Summary[#](#id21 "Permalink to this headline") - Minor enhancements. ## [\[1.7.1.1.2.15.0\]](#id89)[#](#neuron-torch-12150 "Permalink to this headline") Date: 2/24/2021 ### Summary[#](#id23 "Permalink to this headline") - Fix for CVE-2021-3177. ## [\[1.1.7.0\]](#id91)[#](#neuron-torch-11170 "Permalink to this headline") Date: 12/23/2020 ### Summary[#](#id27 "Permalink to this headline") - We are dropping support for Python 3.5 in this release - torch.neuron.trace behavior will now throw a RuntimeError in the case that no operators are compiled for neuron hardware - torch.neuron.trace will now display compilation progress indicators (dots) as default behavior (neuron-cc must updated to the December release to greater to see this feature) - Added new operator support. Please see [PyTorch Neuron (torch-neuron) Supported operators](../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch) for the complete list of operators. - Extended the BERT pretrained tutorial to demonstrate execution on multiple cores and batch modification, updated the tutorial to accomodate changes in the Hugging Face Transformers code for version 4.0 - Added a tutorial for torch-serve which extends the BERT tutorial - Added support for PyTorch 1.7 ## [\[1.0.1978.0\]](#id92)[#](#neuron-torch-1019780 "Permalink to this headline") Date: 11/17/2020 ### Summary[#](#id29 "Permalink to this headline") - Fixed bugs in comparison operators, and added remaining variantes (eq, ne, gt, ge, lt, le) - Added support for prim::PythonOp - note that this must be run on CPU and not Neuron. We recommend you replace this code with PyTorch operators if possible - Support for a series of new operators. Please see [PyTorch Neuron (torch-neuron) Supported operators](../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch) for the complete list of operators. - Performance improvements to the runtime library - Correction of a runtime library bug which caused models with large tensors to generate incorrect results in some cases ## [\[1.0.1721.0\]](#id93)[#](#neuron-torch-1017210 "Permalink to this headline") Date: 09/22/2020 ### Summary[#](#id31 "Permalink to this headline") - Various minor improvements to the Pytorch autopartitioner feature - Support for the operators aten::constant\_pad\_nd, aten::meshgrid - Improved performance on various torchvision models. Of note are resnet50 and vgg16 ## [\[1.0.1532.0\]](#id94)[#](#neuron-torch-1015320 "Permalink to this headline") Date: 08/08/2020 ### Summary[#](#summary-1 "Permalink to this headline") - Various minor improvements to the Pytorch autopartitioner feature - Support for the aten:ones operator ## [\[1.0.1522.0\]](#id95)[#](#neuron-torch-1015220 "Permalink to this headline") Date: 08/05/2020 ### Summary[#](#summary-2 "Permalink to this headline") Various minor improvements. ## [\[1.0.1386.0\]](#id96)[#](#neuron-torch-1013860 "Permalink to this headline") Date: 07/16/2020 ### Summary[#](#summary-3 "Permalink to this headline") This release adds auto-partitioning, model analysis and PyTorch 1.5.1 support, along with a number of new operators ### Major New Features[#](#major-new-features "Permalink to this headline") - Support for Pytorch 1.5.1 - Introduce an automated operator device placement mechanism in torch.neuron.trace to run sub-graphs that contain operators that are not supported by the neuron compiler in native PyTorch. This new mechanism is on by default and can be turned off by adding argument fallback=False to the compiler arguments. - Model analysis to find supported and unsupported operators in a model ### Resolved Issues[#](#id38 "Permalink to this headline") ## [\[1.0.1168.0\]](#id97)[#](#neuron-torch-1011680 "Permalink to this headline") Date 6/11/2020 ### Summary[#](#summary-4 "Permalink to this headline") ### Major New Features[#](#major-new-features-1 "Permalink to this headline") ### Resolved Issues[#](#resolved-issues-1 "Permalink to this headline") ### Known Issues and Limitations[#](#known-issues-and-limitations "Permalink to this headline") ## [\[1.0.1001.0\]](#id98)[#](#neuron-torch-1010010 "Permalink to this headline") Date: 5/11/2020 ### Summary[#](#summary-5 "Permalink to this headline") Additional PyTorch operator support and improved support for model saving and reloading. ### Major New Features[#](#major-new-features-2 "Permalink to this headline") - Added Neuron Compiler support for a number of previously unsupported PyTorch operators. Please see :ref:[\`](#id46)neuron-cc-ops-pytorch\`for the complete list of operators. - Add support for torch.neuron.trace on models which have previously been saved using torch.jit.save and then reloaded. ### Resolved Issues[#](#resolved-issues-2 "Permalink to this headline") ### Known Issues and Limitations[#](#known-issues-and-limitations-1 "Permalink to this headline") ## [\[1.0.825.0\]](#id99)[#](#neuron-torch-108250 "Permalink to this headline") Date: 3/26/2020 ### Summary[#](#summary-6 "Permalink to this headline") ### Major New Features[#](#major-new-features-3 "Permalink to this headline") ### Resolved Issues[#](#resolved-issues-3 "Permalink to this headline") ### Known Issues and limitations[#](#known-issues-and-limitations-2 "Permalink to this headline") ## [\[1.0.763.0\]](#id100)[#](#neuron-torch-107630 "Permalink to this headline") Date: 2/27/2020 ## [\[1.0.672.0\]](#id101)[#](#neuron-torch-106720 "Permalink to this headline") Date: 1/27/2020 ### Summary[#](#summary-8 "Permalink to this headline") ### Major new features[#](#major-new-features-5 "Permalink to this headline") ### Resolved issues[#](#resolved-issues-5 "Permalink to this headline") - Python 3.5 and Python 3.7 are now supported. ### Known issues and limitations[#](#known-issues-and-limitations-3 "Permalink to this headline") ### Other Notes[#](#other-notes "Permalink to this headline") ## [\[1.0.627.0\]](#id102)[#](#neuron-torch-106270 "Permalink to this headline") Date: 12/20/2019 ### Summary[#](#summary-9 "Permalink to this headline") This is the initial release of torch-neuron. It is not distributed on the DLAMI yet and needs to be installed from the neuron pip repository. Note that we are currently using a TensorFlow as an intermediate format to pass to our compiler. This does not affect any runtime execution from PyTorch to Neuron Runtime and Inferentia. This is why the neuron-cc installation must include \[tensorflow\] for PyTorch. ### Major new features[#](#major-new-features-6 "Permalink to this headline") ### Resolved issues[#](#resolved-issues-6 "Permalink to this headline") ### Known issues and limitations[#](#known-issues-and-limitations-4 "Permalink to this headline") ### Models TESTED[#](#models-tested "Permalink to this headline") The following models have successfully run on neuron-inferentia systems 1. SqueezeNet 2. ResNet50 3. Wide ResNet50 ### Pytorch Serving[#](#pytorch-serving "Permalink to this headline") In this initial version there is no specific serving support. Inference works correctly through Python on Inf1 instances using the neuron runtime. Future releases will include support for production deployment and serving of models ### Profiler support[#](#profiler-support "Permalink to this headline") Profiler support is not provided in this initial release and will be available in future releases ### Automated partitioning[#](#automated-partitioning "Permalink to this headline") Automatic partitioning of graphs into supported and non-supported operations is not currently supported. A tutorial is available to provide guidance on how to manually parition a model graph. Please see pytorch-manual-partitioning-jn-tutorial ### PyTorch dependency[#](#pytorch-dependency "Permalink to this headline") Currently PyTorch support depends on a Neuron specific version of PyTorch v1.3.1. Future revisions will add support for 1.4 and future releases. ### Six pip package is required[#](#six-pip-package-is-required "Permalink to this headline") The Six package is required for the torch-neuron runtime, but it is not modeled in the package dependencies. This will be fixed in a future release. ### Multiple NeuronCore support[#](#multiple-neuroncore-support "Permalink to this headline") If the num-neuroncores options is used the number of cores must be manually set in the calling shell environment variable for compilation and inference. For example: Using the keyword argument compiler\_args=\[‘—num-neuroncores’, ‘4’\] in the trace call, requires NEURONCORE\_GROUP\_SIZES=4 to be set in the environment at compile time and runtime ### CPU execution[#](#cpu-execution "Permalink to this headline") At compilation time a constant output is generated for the purposes of tracing. Running inference on a non neuron instance will generate incorrect results. This must not be used. The following error message is generated to stderr: ``` Warning: Tensor output are ** NOT CALCULATED ** during CPU execution and only indicate tensor shape ``` ### Other notes[#](#other-notes-1 "Permalink to this headline") - Python version(s) supported: - 3.6 - Linux distribution supported: - DLAMI Ubuntu 18 and Amazon Linux 2 (using Python 3.6 Conda environments) - Other AMIs based on Ubuntu 18 - For Amazon Linux 2 please install Conda and use Python 3.6 Conda environment _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuron) release notes — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Training (torch-neuronx)" href="../../../frameworks/torch/training-torch-neuronx.html"> <link rel="prev" title="Troubleshooting Guide for PyTorch Neuron (torch-neuron)" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "release-notes/torch/torch-neuron/torch-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Frelease-notes/torch/torch-neuron/torch-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/release-notes/torch/torch-neuron/torch-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/release-notes/torch/torch-neuron/torch-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-updated-03-21-2023"> Known Issues and Limitations - Updated 03/21/2023 </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#min-max-accuracy"> Min &amp; Max Accuracy </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#python-3-5"> Python 3.5 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#torchvision"> Torchvision </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic Batching </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-package-ver-1-2-9-1-0-sdk-ver-2-13-0"> PyTorch Neuron release [package ver. 1.*.*.2.9.1.0, SDK ver. 2.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-package-ver-1-2-8-9-0-sdk-ver-2-12-0"> PyTorch Neuron release [package ver. 1.*.*.2.8.9.0, SDK ver. 2.12.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-7-10-0"> PyTorch Neuron release [2.7.10.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#new-in-this-release"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bug-fixes"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-7-1-0"> PyTorch Neuron release [2.7.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-6-5-0"> PyTorch Neuron release [2.6.5.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-5-0-0"> PyTorch Neuron release [2.5.0.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id3"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id4"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-3-0-0"> PyTorch Neuron release [2.3.0.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id5"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id6"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-2-0-0"> PyTorch Neuron release [2.2.0.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id7"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-1-7-0"> PyTorch Neuron release [2.1.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id8"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id9"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-536-0"> PyTorch Neuron release [2.0.536.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id10"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-468-0"> PyTorch Neuron release [2.0.468.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id11"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-392-0"> PyTorch Neuron release [2.0.392.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-318-0"> PyTorch Neuron release [2.0.318.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id12"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id13"> [1.8.1.1.5.21.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1570"> [1.8.1.1.5.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id15"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1410"> [1.8.1.1.4.1.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id17"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1350"> [1.7.1.1.3.5.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id19"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-12160"> [1.7.1.1.2.16.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id21"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-12150"> [1.7.1.1.2.15.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id23"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1230"> [1.7.1.1.2.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id25"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-11170"> [1.1.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id27"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1019780"> [1.0.1978.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id29"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1017210"> [1.0.1721.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id31"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1015320"> [1.0.1532.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-1"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1015220"> [1.0.1522.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-2"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1013860"> [1.0.1386.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-3"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id38"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1011680"> [1.0.1168.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-4"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-1"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-1"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known Issues and Limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1010010"> [1.0.1001.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-5"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-2"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-2"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-1"> Known Issues and Limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-108250"> [1.0.825.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-6"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-3"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-3"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-2"> Known Issues and limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-107630"> [1.0.763.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-7"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-4"> Major new features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-4"> Resolved issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-106720"> [1.0.672.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-8"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-5"> Major new features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-5"> Resolved issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-3"> Known issues and limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-106270"> [1.0.627.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-9"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-6"> Major new features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-6"> Resolved issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-4"> Known issues and limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#models-tested"> Models TESTED </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-serving"> Pytorch Serving </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#profiler-support"> Profiler support </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#automated-partitioning"> Automated partitioning </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-dependency"> PyTorch dependency </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#trace-behavior"> Trace behavior </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#six-pip-package-is-required"> Six pip package is required </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#multiple-neuroncore-support"> Multiple NeuronCore support </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#cpu-execution"> CPU execution </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-1"> Other notes </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuron) release notes</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-updated-03-21-2023"> Known Issues and Limitations - Updated 03/21/2023 </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#min-max-accuracy"> Min &amp; Max Accuracy </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#python-3-5"> Python 3.5 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#torchvision"> Torchvision </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dynamic-batching"> Dynamic Batching </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-package-ver-1-2-9-1-0-sdk-ver-2-13-0"> PyTorch Neuron release [package ver. 1.*.*.2.9.1.0, SDK ver. 2.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-package-ver-1-2-8-9-0-sdk-ver-2-12-0"> PyTorch Neuron release [package ver. 1.*.*.2.8.9.0, SDK ver. 2.12.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-7-10-0"> PyTorch Neuron release [2.7.10.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#new-in-this-release"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bug-fixes"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-7-1-0"> PyTorch Neuron release [2.7.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-6-5-0"> PyTorch Neuron release [2.6.5.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-5-0-0"> PyTorch Neuron release [2.5.0.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id3"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id4"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-3-0-0"> PyTorch Neuron release [2.3.0.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id5"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id6"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-2-0-0"> PyTorch Neuron release [2.2.0.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id7"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-1-7-0"> PyTorch Neuron release [2.1.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id8"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id9"> Bug fixes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-536-0"> PyTorch Neuron release [2.0.536.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id10"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-468-0"> PyTorch Neuron release [2.0.468.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id11"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-392-0"> PyTorch Neuron release [2.0.392.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-release-2-0-318-0"> PyTorch Neuron release [2.0.318.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id12"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id13"> [1.8.1.1.5.21.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1570"> [1.8.1.1.5.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id15"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1410"> [1.8.1.1.4.1.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id17"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1350"> [1.7.1.1.3.5.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id19"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-12160"> [1.7.1.1.2.16.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id21"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-12150"> [1.7.1.1.2.15.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id23"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1230"> [1.7.1.1.2.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id25"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-11170"> [1.1.7.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id27"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1019780"> [1.0.1978.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id29"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1017210"> [1.0.1721.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id31"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1015320"> [1.0.1532.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-1"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1015220"> [1.0.1522.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-2"> Summary </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1013860"> [1.0.1386.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-3"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id38"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1011680"> [1.0.1168.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-4"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-1"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-1"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known Issues and Limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-1010010"> [1.0.1001.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-5"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-2"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-2"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-1"> Known Issues and Limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-108250"> [1.0.825.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-6"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-3"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-3"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-2"> Known Issues and limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-107630"> [1.0.763.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-7"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-4"> Major new features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-4"> Resolved issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-106720"> [1.0.672.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-8"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-5"> Major new features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-5"> Resolved issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-3"> Known issues and limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-torch-106270"> [1.0.627.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-9"> Summary </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-6"> Major new features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-6"> Resolved issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-4"> Known issues and limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#models-tested"> Models TESTED </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-serving"> Pytorch Serving </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#profiler-support"> Profiler support </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#automated-partitioning"> Automated partitioning </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-dependency"> PyTorch dependency </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#trace-behavior"> Trace behavior </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#six-pip-package-is-required"> Six pip package is required </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#multiple-neuroncore-support"> Multiple NeuronCore support </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#cpu-execution"> CPU execution </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-1"> Other notes </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="pytorch-neuron-torch-neuron-release-notes"> <span id="pytorch-neuron-rn"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>) release notes<a class="headerlink" href="#pytorch-neuron-torch-neuron-release-notes" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#known-issues-and-limitations-updated-03-21-2023" id="id70">Known Issues and Limitations - Updated 03/21/2023</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-package-ver-1-2-9-1-0-sdk-ver-2-13-0" id="id71">PyTorch Neuron release [package ver. 1.*.*.2.9.1.0, SDK ver. 2.13.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-package-ver-1-2-8-9-0-sdk-ver-2-12-0" id="id72">PyTorch Neuron release [package ver. 1.*.*.2.8.9.0, SDK ver. 2.12.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-7-10-0" id="id73">PyTorch Neuron release [2.7.10.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-7-1-0" id="id74">PyTorch Neuron release [2.7.1.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-6-5-0" id="id75">PyTorch Neuron release [2.6.5.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-5-0-0" id="id76">PyTorch Neuron release [2.5.0.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-3-0-0" id="id77">PyTorch Neuron release [2.3.0.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-2-0-0" id="id78">PyTorch Neuron release [2.2.0.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-1-7-0" id="id79">PyTorch Neuron release [2.1.7.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-0-536-0" id="id80">PyTorch Neuron release [2.0.536.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-0-468-0" id="id81">PyTorch Neuron release [2.0.468.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-0-392-0" id="id82">PyTorch Neuron release [2.0.392.0]</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-release-2-0-318-0" id="id83">PyTorch Neuron release [2.0.318.0]</a></p></li> <li><p><a class="reference internal" href="#id13" id="id84">[1.8.1.1.5.21.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1570" id="id85">[1.8.1.1.5.7.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1410" id="id86">[1.8.1.1.4.1.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1350" id="id87">[1.7.1.1.3.5.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-12160" id="id88">[1.7.1.1.2.16.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-12150" id="id89">[1.7.1.1.2.15.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1230" id="id90">[1.7.1.1.2.3.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-11170" id="id91">[1.1.7.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1019780" id="id92">[1.0.1978.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1017210" id="id93">[1.0.1721.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1015320" id="id94">[1.0.1532.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1015220" id="id95">[1.0.1522.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1013860" id="id96">[1.0.1386.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1011680" id="id97">[1.0.1168.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-1010010" id="id98">[1.0.1001.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-108250" id="id99">[1.0.825.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-107630" id="id100">[1.0.763.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-106720" id="id101">[1.0.672.0]</a></p></li> <li><p><a class="reference internal" href="#neuron-torch-106270" id="id102">[1.0.627.0]</a></p></li> </ul> </div> <p>This document lists the release notes for the Pytorch-Neuron package.</p> <div class="section" id="known-issues-and-limitations-updated-03-21-2023"> <h2><a class="toc-backref" href="#id70">Known Issues and Limitations - Updated 03/21/2023</a><a class="headerlink" href="#known-issues-and-limitations-updated-03-21-2023" title="Permalink to this headline">#</a></h2> <div class="section" id="min-max-accuracy"> <h3>Min &amp; Max Accuracy<a class="headerlink" href="#min-max-accuracy" title="Permalink to this headline">#</a></h3> <p>The index outputs of the <code class="docutils literal notranslate"><span class="pre">aten::argmin</span></code>, <code class="docutils literal notranslate"><span class="pre">aten::argmax</span></code>, <code class="docutils literal notranslate"><span class="pre">aten::min</span></code>, and <code class="docutils literal notranslate"><span class="pre">aten::max</span></code> operator implementations are sensitive to precision. For models that contain these operators and have <code class="docutils literal notranslate"><span class="pre">float32</span></code> inputs, we recommend using the <code class="docutils literal notranslate"><span class="pre">--fp32-cast=matmult</span> <span class="pre">--fast-math</span> <span class="pre">no-fast-relayout</span></code> compiler option to avoid numerical imprecision issues. Additionally, the <code class="docutils literal notranslate"><span class="pre">aten::min</span></code> and <code class="docutils literal notranslate"><span class="pre">aten::max</span></code> operator implementations do not currently support <code class="docutils literal notranslate"><span class="pre">int64</span></code> inputs when <code class="docutils literal notranslate"><span class="pre">dim=0</span></code>. For more information on precision and performance-accuracy tuning, see <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html#neuron-cc-training-mixed-precision"><span class="std std-ref">Mixed precision and performance-accuracy tuning (neuron-cc)</span></a>.</p> </div> <div class="section" id="python-3-5"> <h3>Python 3.5<a class="headerlink" href="#python-3-5" title="Permalink to this headline">#</a></h3> <p>If you attempt to import torch.neuron from Python 3.5 you will see this error in 1.1.7.0 - please use Python 3.6 or greater:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">File</span> <span class="s2">"/tmp/install_test_env/lib/python3.5/site-packages/torch_neuron/__init__.py"</span><span class="p">,</span> <span class="n">line</span> <span class="mi">29</span> <span class="sa">f</span><span class="s1">'Invalid dependency version torch==</span><span class="si">{</span><span class="n">torch</span><span class="o">.</span><span class="n">__version__</span><span class="si">}</span><span class="s1">. '</span> <span class="o">^</span> <span class="ne">SyntaxError</span><span class="p">:</span> <span class="n">invalid</span> <span class="n">syntax</span> </pre></div> </div> <ul class="simple"> <li><p>Torchvision has dropped support for Python 3.5</p></li> <li><p>HuggingFace transformers has dropped support for Python 3.5</p></li> </ul> </div> <div class="section" id="torchvision"> <h3>Torchvision<a class="headerlink" href="#torchvision" title="Permalink to this headline">#</a></h3> <p>When versions of <code class="docutils literal notranslate"><span class="pre">torchvision</span></code> and <code class="docutils literal notranslate"><span class="pre">torch</span></code> are mismatched, this can result in exceptions when compiling <code class="docutils literal notranslate"><span class="pre">torchvision</span></code> based models. Specific versions of <code class="docutils literal notranslate"><span class="pre">torchvision</span></code> are built against each release of <code class="docutils literal notranslate"><span class="pre">torch</span></code>. For example:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">torch==1.5.1</span></code> matches <code class="docutils literal notranslate"><span class="pre">torchvision==0.6.1</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">torch==1.7.1</span></code> matches <code class="docutils literal notranslate"><span class="pre">torchvision==0.8.2</span></code></p></li> <li><p>etc.</p></li> </ul> <p>Simultaneously installing both <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> and <code class="docutils literal notranslate"><span class="pre">torchvision</span></code> is the recommended method of correctly resolving versions.</p> </div> <div class="section" id="dynamic-batching"> <h3>Dynamic Batching<a class="headerlink" href="#dynamic-batching" title="Permalink to this headline">#</a></h3> <p>Dynamic batching does not work properly for some models that use the <code class="docutils literal notranslate"><span class="pre">aten::size</span></code> operator. When this issue occurs, the input batch sizes are not properly recorded at inference time, resulting in an error such as:</p> <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>RuntimeError: The size of tensor a (X) must match the size of tensor b (Y) at non-singleton dimension 0. </pre></div> </div> <p>This error typically occurs when <code class="docutils literal notranslate"><span class="pre">aten::size</span></code> operators are partitioned to CPU. We are investigating a fix for this issue.</p> </div> </div> <div class="section" id="pytorch-neuron-release-package-ver-1-2-9-1-0-sdk-ver-2-13-0"> <h2><a class="toc-backref" href="#id71">PyTorch Neuron release [package ver. 1.*.*.2.9.1.0, SDK ver. 2.13.0]</a><a class="headerlink" href="#pytorch-neuron-release-package-ver-1-2-9-1-0-sdk-ver-2-13-0" title="Permalink to this headline">#</a></h2> <p>Date: 8/28/2023</p> <ul class="simple"> <li><p>Added support for clamp_min/clamp_max ATEN operators.</p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-package-ver-1-2-8-9-0-sdk-ver-2-12-0"> <h2><a class="toc-backref" href="#id72">PyTorch Neuron release [package ver. 1.*.*.2.8.9.0, SDK ver. 2.12.0]</a><a class="headerlink" href="#pytorch-neuron-release-package-ver-1-2-8-9-0-sdk-ver-2-12-0" title="Permalink to this headline">#</a></h2> <p>Date: 7/19/2023</p> <ul class="simple"> <li><p>Minor updates.</p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-2-7-10-0"> <h2><a class="toc-backref" href="#id73">PyTorch Neuron release [2.7.10.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-7-10-0" title="Permalink to this headline">#</a></h2> <p>Date: 6/14/2023</p> <div class="section" id="new-in-this-release"> <h3>New in this release<a class="headerlink" href="#new-in-this-release" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added support for Python 3.10</p></li> </ul> </div> <div class="section" id="bug-fixes"> <h3>Bug fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>torch.pow Operation now correctly handles mismatch between base and exponent data types</p></li> </ul> </div> </div> <div class="section" id="pytorch-neuron-release-2-7-1-0"> <h2><a class="toc-backref" href="#id74">PyTorch Neuron release [2.7.1.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-7-1-0" title="Permalink to this headline">#</a></h2> <p>Date: 05/1/2023</p> <ul class="simple"> <li><p>Minor updates.</p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-2-6-5-0"> <h2><a class="toc-backref" href="#id75">PyTorch Neuron release [2.6.5.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-6-5-0" title="Permalink to this headline">#</a></h2> <p>Date: 03/28/2023</p> <div class="section" id="id1"> <h3>New in this release<a class="headerlink" href="#id1" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added support for <code class="docutils literal notranslate"><span class="pre">torch==1.13.1</span></code></p></li> <li><p>New releases of <code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code> no longer include versions for <code class="docutils literal notranslate"><span class="pre">torch==1.7</span></code> and <code class="docutils literal notranslate"><span class="pre">torch==1.8</span></code></p></li> <li><p>Added support for Neuron runtime 2.12</p></li> <li><p>Added support for new operators:</p> <ul> <li><p><code class="docutils literal notranslate"><span class="pre">aten::tensordot</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::adaptive_avg_pool1d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::prelu</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::reflection_pad2d</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::baddbmm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::repeat</span></code></p></li> </ul> </li> <li><p>Added a <code class="docutils literal notranslate"><span class="pre">separate_weights</span></code> flag to <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> to support models that are larger than 2GB</p></li> </ul> </div> <div class="section" id="id2"> <h3>Bug fixes<a class="headerlink" href="#id2" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fixed <code class="docutils literal notranslate"><span class="pre">aten::_convolution</span></code> with grouping for:</p> <ul> <li><p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Conv1d.html#torch.nn.Conv1d" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.Conv1d</span></code></a></p></li> <li><p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.Conv3d.html#torch.nn.Conv3d" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.Conv3d</span></code></a></p></li> <li><p><a class="reference external" href="https://pytorch.org/docs/master/generated/torch.nn.ConvTranspose2d.html#torch.nn.ConvTranspose2d" title="(in PyTorch vmaster (2.1.0a0+gitbe0b12e ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.ConvTranspose2d</span></code></a></p></li> </ul> </li> <li><p>Fixed <code class="docutils literal notranslate"><span class="pre">aten::linear</span></code> to support 1d input tensors</p></li> <li><p>Fixed an issue where an input could not be directly returned from the network</p></li> </ul> </div> </div> <div class="section" id="pytorch-neuron-release-2-5-0-0"> <h2><a class="toc-backref" href="#id76">PyTorch Neuron release [2.5.0.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-5-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 11/23/2022</p> <div class="section" id="id3"> <h3>New in this release<a class="headerlink" href="#id3" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added PyTorch 1.12 support</p></li> <li><p>Added Python 3.8 support</p></li> <li><p>Added new operators support. See <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a></p></li> <li><p>Added support for <code class="docutils literal notranslate"><span class="pre">aten::lstm</span></code>. See: <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html#torch-neuron-lstm-support"><span class="std std-ref">Developer Guide - PyTorch Neuron (torch-neuron) LSTM Support</span></a></p></li> <li><p>Improved logging:</p> <ul> <li><p>Improved error messages for specific compilation failure modes, including out-of-memory errors</p></li> <li><p>Added a warning to show the code location of <code class="docutils literal notranslate"><span class="pre">prim::PythonOp</span></code> operations</p></li> <li><p>Removed overly-verbose tracing messages</p></li> <li><p>Added improved error messages for <code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code> and <code class="docutils literal notranslate"><span class="pre">tensorflow</span></code> dependency issues</p></li> <li><p>Added more debug information when an invalid dynamic batching configuration is used</p></li> </ul> </li> <li><p>Added new experimental explicit NeuronCore placement API. See: <span class="xref std std-ref">torch_neuron_core_placement_api</span></p></li> <li><p>Added new guide for NeuronCore placement. See: <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html#torch-neuron-core-placement-guide"><span class="std std-ref">PyTorch Neuron (torch-neuron) Core Placement</span></a></p></li> <li><p>Improved <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> performance when using large graphs</p></li> <li><p>Reduced host memory usage of loaded models in <code class="docutils literal notranslate"><span class="pre">libtorchneuron.so</span></code></p></li> <li><p>Added <code class="docutils literal notranslate"><span class="pre">single_fusion_ratio_threshold</span></code> argument to <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> to give more fine-grained control of partitioned graphs</p></li> </ul> </div> <div class="section" id="id4"> <h3>Bug fixes<a class="headerlink" href="#id4" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Improved handling of tensor mutations which previously caused accuracy issues on certain models (i.e. yolor, yolov5)</p></li> <li><p>Fixed an issue where <code class="docutils literal notranslate"><span class="pre">inf</span></code> and <code class="docutils literal notranslate"><span class="pre">-inf</span></code> values would cause unexpected <code class="docutils literal notranslate"><span class="pre">NaN</span></code> values. This could occur with newer versions of <code class="docutils literal notranslate"><span class="pre">transformers</span></code></p></li> <li><p>Fixed an issue where <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html#torch.neuron.DataParallel" title="torch.neuron.DataParallel"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch.neuron.DataParallel()</span></code></a> would not fully utilize all NeuronCores for specific batch sizes</p></li> <li><p>Fixed and improved operators:</p> <ul> <li><p><code class="docutils literal notranslate"><span class="pre">aten::upsample_bilinear2d</span></code>: Improved error messages in cases where the operation cannot be supported</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::_convolution</span></code>: Added support for <code class="docutils literal notranslate"><span class="pre">output_padding</span></code> argument</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::div</span></code>: Added support for <code class="docutils literal notranslate"><span class="pre">rounding_mode</span></code> argument</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::sum</span></code>: Fixed to handle non-numeric data types</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::expand</span></code>: Fixed to handle scalar tensors</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::permute</span></code>: Fixed to handle negative indices</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::min</span></code>: Fixed to support more input types</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::max</span></code>: Fixed to support more input types</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::max_pool2d</span></code>: Fixed to support both 3-dimensional and 4-dimensional input tensors</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::Int</span></code>: Fixed an issue where long values would incorrectly lose precision</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::constant_pad_nd</span></code>: Fixed to correctly use non-0 padding values</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::pow</span></code>: Fixed to support more input types &amp; values</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::avg_pool2d</span></code>: Added support for <code class="docutils literal notranslate"><span class="pre">count_include_pad</span></code> argument. Added support for <code class="docutils literal notranslate"><span class="pre">ceil_mode</span></code> argument if padding isn’t specified</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::zero</span></code>: Fixed to handle scalars correctly</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">prim::Constant</span></code>: Fixed an issue where <code class="docutils literal notranslate"><span class="pre">-inf</span></code> was incorrectly handled</p></li> <li><p>Improved handling of scalars in arithmetic operators</p></li> </ul> </li> </ul> </div> </div> <div class="section" id="pytorch-neuron-release-2-3-0-0"> <h2><a class="toc-backref" href="#id77">PyTorch Neuron release [2.3.0.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-3-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 04/29/2022</p> <div class="section" id="id5"> <h3>New in this release<a class="headerlink" href="#id5" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added support PyTorch 1.11.</p></li> <li><p>Updated PyTorch 1.10 to version 1.10.2.</p></li> <li><p>End of support for torch-neuron 1.5, see <a class="reference internal" href="../../../general/announcements/neuron1.x/eol-pt-15.html#eol-pt-15"><span class="std std-ref">End of support for torch-neuron version 1.5</span></a>.</p></li> <li><p>Added support for new operators:</p> <ul> <li><p><code class="docutils literal notranslate"><span class="pre">aten::masked_fill_</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::new_zeros</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::frobenius_norm</span></code></p></li> </ul> </li> </ul> </div> <div class="section" id="id6"> <h3>Bug fixes<a class="headerlink" href="#id6" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Improved <code class="docutils literal notranslate"><span class="pre">aten::gelu</span></code> accuracy</p></li> <li><p>Updated <code class="docutils literal notranslate"><span class="pre">aten::meshgrid</span></code> to support optional indexing argument introduced in <code class="docutils literal notranslate"><span class="pre">torch</span> <span class="pre">1.10</span></code> , see <a class="reference external" href="https://github.com/pytorch/pytorch/issues/50276">PyTorch issue 50276</a></p></li> </ul> </div> </div> <div class="section" id="pytorch-neuron-release-2-2-0-0"> <h2><a class="toc-backref" href="#id78">PyTorch Neuron release [2.2.0.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-2-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 03/25/2022</p> <div class="section" id="id7"> <h3>New in this release<a class="headerlink" href="#id7" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added full support for <code class="docutils literal notranslate"><span class="pre">aten::max_pool2d_with_indices</span></code> - (Was previously supported only when indices were unused).</p></li> <li><p>Added new torch-neuron packages compiled with <code class="docutils literal notranslate"><span class="pre">-D_GLIBCXX_USE_CXX11_ABI=1</span></code>, the new packages support PyTorch 1.8, PyTorch 1.9, and PyTorch 1.10. To install the additional packages compiled with <code class="docutils literal notranslate"><span class="pre">-D_GLIBCXX_USE_CXX11_ABI=1</span></code> please change the package repo index to <code class="docutils literal notranslate"><span class="pre">https://pip.repos.neuron.amazonaws.com</span> <span class="pre">(https://pip.repos.neuron.amazonaws.com/)/cxx11/</span></code></p></li> </ul> </div> </div> <div class="section" id="pytorch-neuron-release-2-1-7-0"> <h2><a class="toc-backref" href="#id79">PyTorch Neuron release [2.1.7.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-1-7-0" title="Permalink to this headline">#</a></h2> <p>Date: 01/20/2022</p> <div class="section" id="id8"> <h3>New in this release<a class="headerlink" href="#id8" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added PyTorch 1.10 support</p></li> <li><p>Added new operators support, see <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a></p></li> <li><p>Updated <code class="docutils literal notranslate"><span class="pre">aten::_convolution</span></code> to support 2d group convolution</p></li> <li><p>Updated <code class="docutils literal notranslate"><span class="pre">neuron::forward</span></code> operators to allocate less dynamic memory. This can increase performance on models with many input &amp; output tensors.</p></li> <li><p>Updated <code class="docutils literal notranslate"><span class="pre">neuron::forward</span></code> to better handle batch sizes when <code class="docutils literal notranslate"><span class="pre">dynamic_batch_size=True</span></code>. This can increase performance at inference time when the input batch size is exactly equal to the traced model batch size.</p></li> </ul> </div> <div class="section" id="id9"> <h3>Bug fixes<a class="headerlink" href="#id9" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added the ability to <code class="docutils literal notranslate"><span class="pre">torch.jit.trace</span></code> a <code class="docutils literal notranslate"><span class="pre">torch.nn.Module</span></code> where a submodule has already been traced with <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> on a CPU-type instance. Previously, if this had been executed on a CPU-type instance, an initialization exception would have been thrown.</p></li> <li><p>Fixed <code class="docutils literal notranslate"><span class="pre">aten::matmul</span></code> behavior on 1-dimensional by n-dimensional multiplies. Previously, this would cause a validation error.</p></li> <li><p>Fixed binary operator type promotion. Previously, in unusual situations, operators like <code class="docutils literal notranslate"><span class="pre">aten::mul</span></code> could produce incorrect results due to invalid casting.</p></li> <li><p>Fixed <code class="docutils literal notranslate"><span class="pre">aten::select</span></code> when index was -1. Previously, this would cause a validation error.</p></li> <li><p>Fixed <code class="docutils literal notranslate"><span class="pre">aten::adaptive_avg_pool2d</span></code> padding and striding behavior. Previously, this could generate incorrect results with specific configurations.</p></li> <li><p>Fixed an issue where dictionary inputs could be incorrectly traced when the tensor values had gradients.</p></li> </ul> </div> </div> <div class="section" id="pytorch-neuron-release-2-0-536-0"> <h2><a class="toc-backref" href="#id80">PyTorch Neuron release [2.0.536.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-0-536-0" title="Permalink to this headline">#</a></h2> <p>Date: 01/05/2022</p> <div class="section" id="id10"> <h3>New in this release<a class="headerlink" href="#id10" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added new operator support for specific variants of operations (See <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a>)</p></li> <li><p>Added optional <code class="docutils literal notranslate"><span class="pre">optimizations</span></code> keyword to <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.trace" title="torch_neuron.trace"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuron.trace()</span></code></a> which accepts a list of <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html#torch_neuron.Optimization" title="torch_neuron.Optimization"><code class="xref py py-class docutils literal notranslate"><span class="pre">Optimization</span></code></a> passes.</p></li> </ul> </div> </div> <div class="section" id="pytorch-neuron-release-2-0-468-0"> <h2><a class="toc-backref" href="#id81">PyTorch Neuron release [2.0.468.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-0-468-0" title="Permalink to this headline">#</a></h2> <p>Date: 12/15/2021</p> <div class="section" id="id11"> <h3>New in this release<a class="headerlink" href="#id11" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added support for <code class="docutils literal notranslate"><span class="pre">aten::cumsum</span></code> operation.</p></li> <li><p>Fixed <code class="docutils literal notranslate"><span class="pre">aten::expand</span></code> to correctly handle adding new dimensions.</p></li> </ul> </div> </div> <div class="section" id="pytorch-neuron-release-2-0-392-0"> <h2><a class="toc-backref" href="#id82">PyTorch Neuron release [2.0.392.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-0-392-0" title="Permalink to this headline">#</a></h2> <p>Date: 11/05/2021</p> <ul class="simple"> <li><p>Updated Neuron Runtime (which is integrated within this package) to <code class="docutils literal notranslate"><span class="pre">libnrt</span> <span class="pre">2.2.18.0</span></code> to fix a container issue that was preventing the use of containers when /dev/neuron0 was not present. See details here <span class="xref std std-ref">neuron-runtime-release-notes</span>.</p></li> </ul> </div> <div class="section" id="pytorch-neuron-release-2-0-318-0"> <h2><a class="toc-backref" href="#id83">PyTorch Neuron release [2.0.318.0]</a><a class="headerlink" href="#pytorch-neuron-release-2-0-318-0" title="Permalink to this headline">#</a></h2> <p>Date: 10/27/2021</p> <div class="section" id="id12"> <h3>New in this release<a class="headerlink" href="#id12" title="Permalink to this headline">#</a></h3> <ul> <li><p>PyTorch Neuron 1.x now support Neuron Runtime 2.x (<code class="docutils literal notranslate"><span class="pre">libnrt.so</span></code> shared library) only.</p> <div class="admonition important"> <p class="admonition-title">Important</p> <ul class="simple"> <li><p>You must update to the latest Neuron Driver (<code class="docutils literal notranslate"><span class="pre">aws-neuron-dkms</span></code> version 2.1 or newer) for proper functionality of the new runtime library.</p></li> <li><p>Read <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt"><span class="std std-ref">Introducing Neuron Runtime 2.x (libnrt.so)</span></a> application note that describes <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-why"><span class="std std-ref">why are we making this change</span></a> and how <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-how-sdk"><span class="std std-ref">this change will affect the Neuron SDK</span></a> in detail.</p></li> <li><p>Read <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#neuron-migrating-apps-neuron-to-libnrt"><span class="std std-ref">Migrate your application to Neuron Runtime 2.x (libnrt.so)</span></a> for detailed information of how to migrate your application.</p></li> </ul> </div> </li> <li><p>Introducing PyTorch 1.9.1 support (support for <code class="docutils literal notranslate"><span class="pre">torch==1.9.1)</span></code></p></li> <li><p>Added <code class="docutils literal notranslate"><span class="pre">torch_neuron.DataParallel</span></code>, see ResNet-50 tutorial <a class="reference internal" href="../../../src/examples/pytorch/resnet50.html"><span class="std std-ref">[html]</span></a> and <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html#torch-neuron-dataparallel-app-note"><span class="std std-ref">Data Parallel Inference on Torch Neuron</span></a> application note.</p></li> <li><p>Added support for tracing on GPUs</p></li> <li><p>Added support for <code class="docutils literal notranslate"><span class="pre">ConvTranspose1d</span></code></p></li> <li><p>Added support for new operators:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">aten::empty_like</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::log</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::type_as</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::movedim</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::einsum</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::argmax</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::min</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::argmin</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::abs</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::cos</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::sin</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::linear</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::pixel_shuffle</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::group_norm</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">aten::_weight_norm</span></code></p></li> </ul> </li> <li><p>Added <code class="docutils literal notranslate"><span class="pre">torch_neuron.is_available()</span></code></p></li> </ul> </div> <div class="section" id="resolved-issues"> <h3>Resolved Issues<a class="headerlink" href="#resolved-issues" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fixed a performance issue when using both the <code class="docutils literal notranslate"><span class="pre">dynamic_batch_size=True</span></code> trace option and <code class="docutils literal notranslate"><span class="pre">--neuron-core-pipeline</span></code> compiler option. Dynamic batching now uses <code class="docutils literal notranslate"><span class="pre">OpenMP</span></code> to execute pipeline batches concurrently.</p></li> <li><p>Fixed <code class="docutils literal notranslate"><span class="pre">torch_neuron.trace</span></code> issues:</p> <ul> <li><p>Fixed a failure when the same submodule was traced with multiple inputs</p></li> <li><p>Fixed a failure where some operations would fail to be called with the correct arguments</p></li> <li><p>Fixed a failure where custom operators (torch plugins) would cause a trace failure</p></li> </ul> </li> <li><p>Fixed variants of <code class="docutils literal notranslate"><span class="pre">aten::upsample_bilinear2d</span></code> when <code class="docutils literal notranslate"><span class="pre">scale_factor=1</span></code></p></li> <li><p>Fixed variants of <code class="docutils literal notranslate"><span class="pre">aten::expand</span></code> using <code class="docutils literal notranslate"><span class="pre">dim=-1</span></code></p></li> <li><p>Fixed variants of <code class="docutils literal notranslate"><span class="pre">aten::stack</span></code> using multiple different input data types</p></li> <li><p>Fixed variants of <code class="docutils literal notranslate"><span class="pre">aten::max</span></code> using indices outputs</p></li> </ul> </div> </div> <div class="section" id="id13"> <h2><a class="toc-backref" href="#id84">[1.8.1.1.5.21.0]</a><a class="headerlink" href="#id13" title="Permalink to this headline">#</a></h2> <p>Date: 08/12/2021</p> <div class="section" id="summary"> <h3>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Minor updates.</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-1570"> <span id="id14"></span><h2><a class="toc-backref" href="#id85">[1.8.1.1.5.7.0]</a><a class="headerlink" href="#neuron-torch-1570" title="Permalink to this headline">#</a></h2> <p>Date: 07/02/2021</p> <div class="section" id="id15"> <h3>Summary<a class="headerlink" href="#id15" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added support for dictionary outputs using <code class="docutils literal notranslate"><span class="pre">strict=False</span></code> flag. See <span class="xref std std-ref">/neuron-guide/neuron-frameworks/pytorch-neuron/troubleshooting-guide.rst</span>.</p></li> <li><p>Updated <code class="docutils literal notranslate"><span class="pre">aten::batch_norm</span></code> to correctly implement the <code class="docutils literal notranslate"><span class="pre">affine</span></code> flag.</p></li> <li><p>Added support for <code class="docutils literal notranslate"><span class="pre">aten::erf</span></code> and <code class="docutils literal notranslate"><span class="pre">prim::DictConstruct</span></code>. See <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a>.</p></li> <li><p>Added dynamic batch support. See <span class="xref std std-ref">/neuron-guide/neuron-frameworks/pytorch-neuron/api-compilation-python-api.rst</span>.</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-1410"> <span id="id16"></span><h2><a class="toc-backref" href="#id86">[1.8.1.1.4.1.0]</a><a class="headerlink" href="#neuron-torch-1410" title="Permalink to this headline">#</a></h2> <p>Date: 5/28/2021</p> <div class="section" id="id17"> <h3>Summary<a class="headerlink" href="#id17" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added support for PyTorch 1.8.1</p> <ul> <li><p>Models compatibility</p> <ul> <li><p>Models compiled with previous versions of PyTorch Neuron (&lt;1.8.1) are compatible with PyTorch Neuron 1.8.1.</p></li> <li><p>Models compiled with PyTorch Neuron 1.8.1 are not backward compatible with previous versions of PyTorch Neuron (&lt;1.8.1) .</p></li> </ul> </li> <li><p>Updated tutorials to use Hugging Face Transformers 4.6.0.</p></li> <li><p>Added a new set of forward operators (forward_v2)</p></li> <li><p>Host memory allocation when loading the same model on multiple NeuronCores is significantly reduced</p></li> <li><p>Fixed an issue where models would not deallocate all memory within a python session after being garbage collected.</p></li> <li><p>Fixed a TorchScript/C++ issue where loading the same model multiple times would not use multiple NeuronCores by default.</p></li> </ul> </li> <li><p>Fixed logging to no longer configure the root logger.</p></li> <li><p>Removed informative messages that were produced during compilations as warnings. The number of warnings reduced significantly.</p></li> <li><p>Convolution operator support has been extended to include ConvTranspose2d variants.</p></li> <li><p>Reduce the amount of host memory usage during inference.</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-1350"> <span id="id18"></span><h2><a class="toc-backref" href="#id87">[1.7.1.1.3.5.0]</a><a class="headerlink" href="#neuron-torch-1350" title="Permalink to this headline">#</a></h2> <p>Date: 4/30/2021</p> <div class="section" id="id19"> <h3>Summary<a class="headerlink" href="#id19" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>ResNext models now functional with new operator support</p></li> <li><p>Yolov5 support refer to <a class="reference external" href="https://github.com/aws/aws-neuron-sdk/issues/253">https://github.com/aws/aws-neuron-sdk/issues/253</a> note <a class="reference external" href="https://github.com/ultralytics/yolov5/pull/2953">https://github.com/ultralytics/yolov5/pull/2953</a> which optimized YoloV5 for AWS Neuron</p></li> <li><p>Convolution operator support has been extended to include most Conv1d and Conv3d variants</p></li> <li><p>New operator support. Please see <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a> for the complete list of operators.</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-12160"> <span id="id20"></span><h2><a class="toc-backref" href="#id88">[1.7.1.1.2.16.0]</a><a class="headerlink" href="#neuron-torch-12160" title="Permalink to this headline">#</a></h2> <p>Date: 3/4/2021</p> <div class="section" id="id21"> <h3>Summary<a class="headerlink" href="#id21" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Minor enhancements.</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-12150"> <span id="id22"></span><h2><a class="toc-backref" href="#id89">[1.7.1.1.2.15.0]</a><a class="headerlink" href="#neuron-torch-12150" title="Permalink to this headline">#</a></h2> <p>Date: 2/24/2021</p> <div class="section" id="id23"> <h3>Summary<a class="headerlink" href="#id23" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fix for CVE-2021-3177.</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-1230"> <span id="id24"></span><h2><a class="toc-backref" href="#id90">[1.7.1.1.2.3.0]</a><a class="headerlink" href="#neuron-torch-1230" title="Permalink to this headline">#</a></h2> <p>Date: 1/30/2021</p> <div class="section" id="id25"> <h3>Summary<a class="headerlink" href="#id25" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Made changes to allow models with -inf scalar constants to correctly compile</p></li> <li><p>Added new operator support. Please see <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a> for the complete list of operators.</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-11170"> <span id="id26"></span><h2><a class="toc-backref" href="#id91">[1.1.7.0]</a><a class="headerlink" href="#neuron-torch-11170" title="Permalink to this headline">#</a></h2> <p>Date: 12/23/2020</p> <div class="section" id="id27"> <h3>Summary<a class="headerlink" href="#id27" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>We are dropping support for Python 3.5 in this release</p></li> <li><p>torch.neuron.trace behavior will now throw a RuntimeError in the case that no operators are compiled for neuron hardware</p></li> <li><p>torch.neuron.trace will now display compilation progress indicators (dots) as default behavior (neuron-cc must updated to the December release to greater to see this feature)</p></li> <li><p>Added new operator support. Please see <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a> for the complete list of operators.</p></li> <li><p>Extended the BERT pretrained tutorial to demonstrate execution on multiple cores and batch modification, updated the tutorial to accomodate changes in the Hugging Face Transformers code for version 4.0</p></li> <li><p>Added a tutorial for torch-serve which extends the BERT tutorial</p></li> <li><p>Added support for PyTorch 1.7</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-1019780"> <span id="id28"></span><h2><a class="toc-backref" href="#id92">[1.0.1978.0]</a><a class="headerlink" href="#neuron-torch-1019780" title="Permalink to this headline">#</a></h2> <p>Date: 11/17/2020</p> <div class="section" id="id29"> <h3>Summary<a class="headerlink" href="#id29" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fixed bugs in comparison operators, and added remaining variantes (eq, ne, gt, ge, lt, le)</p></li> <li><p>Added support for prim::PythonOp - note that this must be run on CPU and not Neuron. We recommend you replace this code with PyTorch operators if possible</p></li> <li><p>Support for a series of new operators. Please see <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a> for the complete list of operators.</p></li> <li><p>Performance improvements to the runtime library</p></li> <li><p>Correction of a runtime library bug which caused models with large tensors to generate incorrect results in some cases</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-1017210"> <span id="id30"></span><h2><a class="toc-backref" href="#id93">[1.0.1721.0]</a><a class="headerlink" href="#neuron-torch-1017210" title="Permalink to this headline">#</a></h2> <p>Date: 09/22/2020</p> <div class="section" id="id31"> <h3>Summary<a class="headerlink" href="#id31" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Various minor improvements to the Pytorch autopartitioner feature</p></li> <li><p>Support for the operators aten::constant_pad_nd, aten::meshgrid</p></li> <li><p>Improved performance on various torchvision models. Of note are resnet50 and vgg16</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-1015320"> <span id="id32"></span><h2><a class="toc-backref" href="#id94">[1.0.1532.0]</a><a class="headerlink" href="#neuron-torch-1015320" title="Permalink to this headline">#</a></h2> <p>Date: 08/08/2020</p> <div class="section" id="summary-1"> <span id="id33"></span><h3>Summary<a class="headerlink" href="#summary-1" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Various minor improvements to the Pytorch autopartitioner feature</p></li> <li><p>Support for the aten:ones operator</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-1015220"> <span id="id34"></span><h2><a class="toc-backref" href="#id95">[1.0.1522.0]</a><a class="headerlink" href="#neuron-torch-1015220" title="Permalink to this headline">#</a></h2> <p>Date: 08/05/2020</p> <div class="section" id="summary-2"> <span id="id35"></span><h3>Summary<a class="headerlink" href="#summary-2" title="Permalink to this headline">#</a></h3> <p>Various minor improvements.</p> </div> </div> <div class="section" id="neuron-torch-1013860"> <span id="id36"></span><h2><a class="toc-backref" href="#id96">[1.0.1386.0]</a><a class="headerlink" href="#neuron-torch-1013860" title="Permalink to this headline">#</a></h2> <p>Date: 07/16/2020</p> <div class="section" id="summary-3"> <span id="id37"></span><h3>Summary<a class="headerlink" href="#summary-3" title="Permalink to this headline">#</a></h3> <p>This release adds auto-partitioning, model analysis and PyTorch 1.5.1 support, along with a number of new operators</p> </div> <div class="section" id="major-new-features"> <h3>Major New Features<a class="headerlink" href="#major-new-features" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Support for Pytorch 1.5.1</p></li> <li><p>Introduce an automated operator device placement mechanism in torch.neuron.trace to run sub-graphs that contain operators that are not supported by the neuron compiler in native PyTorch. This new mechanism is on by default and can be turned off by adding argument fallback=False to the compiler arguments.</p></li> <li><p>Model analysis to find supported and unsupported operators in a model</p></li> </ul> </div> <div class="section" id="id38"> <h3>Resolved Issues<a class="headerlink" href="#id38" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="neuron-torch-1011680"> <span id="id39"></span><h2><a class="toc-backref" href="#id97">[1.0.1168.0]</a><a class="headerlink" href="#neuron-torch-1011680" title="Permalink to this headline">#</a></h2> <p>Date 6/11/2020</p> <div class="section" id="summary-4"> <span id="id40"></span><h3>Summary<a class="headerlink" href="#summary-4" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="major-new-features-1"> <span id="id41"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-1" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="resolved-issues-1"> <span id="id42"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-1" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="known-issues-and-limitations"> <h3>Known Issues and Limitations<a class="headerlink" href="#known-issues-and-limitations" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="neuron-torch-1010010"> <span id="id43"></span><h2><a class="toc-backref" href="#id98">[1.0.1001.0]</a><a class="headerlink" href="#neuron-torch-1010010" title="Permalink to this headline">#</a></h2> <p>Date: 5/11/2020</p> <div class="section" id="summary-5"> <span id="id44"></span><h3>Summary<a class="headerlink" href="#summary-5" title="Permalink to this headline">#</a></h3> <p>Additional PyTorch operator support and improved support for model saving and reloading.</p> </div> <div class="section" id="major-new-features-2"> <span id="id45"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-2" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added Neuron Compiler support for a number of previously unsupported PyTorch operators. Please see :ref:<a href="#id46"><span class="problematic" id="id47">`</span></a>neuron-cc-ops-pytorch`for the complete list of operators.</p></li> <li><p>Add support for torch.neuron.trace on models which have previously been saved using torch.jit.save and then reloaded.</p></li> </ul> </div> <div class="section" id="resolved-issues-2"> <span id="id48"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-2" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="known-issues-and-limitations-1"> <span id="id49"></span><h3>Known Issues and Limitations<a class="headerlink" href="#known-issues-and-limitations-1" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="neuron-torch-108250"> <span id="id50"></span><h2><a class="toc-backref" href="#id99">[1.0.825.0]</a><a class="headerlink" href="#neuron-torch-108250" title="Permalink to this headline">#</a></h2> <p>Date: 3/26/2020</p> <div class="section" id="summary-6"> <span id="id51"></span><h3>Summary<a class="headerlink" href="#summary-6" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="major-new-features-3"> <span id="id52"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-3" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="resolved-issues-3"> <span id="id53"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-3" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="known-issues-and-limitations-2"> <span id="id54"></span><h3>Known Issues and limitations<a class="headerlink" href="#known-issues-and-limitations-2" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="neuron-torch-107630"> <span id="id55"></span><h2><a class="toc-backref" href="#id100">[1.0.763.0]</a><a class="headerlink" href="#neuron-torch-107630" title="Permalink to this headline">#</a></h2> <p>Date: 2/27/2020</p> <div class="section" id="summary-7"> <span id="id56"></span><h3>Summary<a class="headerlink" href="#summary-7" title="Permalink to this headline">#</a></h3> <p>Added Neuron Compiler support for a number of previously unsupported PyTorch operators. Please see <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html#neuron-cc-ops-pytorch"><span class="std std-ref">PyTorch Neuron (torch-neuron) Supported operators</span></a> for the complete list of operators.</p> </div> <div class="section" id="major-new-features-4"> <span id="id57"></span><h3>Major new features<a class="headerlink" href="#major-new-features-4" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>None</p></li> </ul> </div> <div class="section" id="resolved-issues-4"> <span id="id58"></span><h3>Resolved issues<a class="headerlink" href="#resolved-issues-4" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>None</p></li> </ul> </div> </div> <div class="section" id="neuron-torch-106720"> <span id="id59"></span><h2><a class="toc-backref" href="#id101">[1.0.672.0]</a><a class="headerlink" href="#neuron-torch-106720" title="Permalink to this headline">#</a></h2> <p>Date: 1/27/2020</p> <div class="section" id="summary-8"> <span id="id60"></span><h3>Summary<a class="headerlink" href="#summary-8" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="major-new-features-5"> <span id="id61"></span><h3>Major new features<a class="headerlink" href="#major-new-features-5" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="resolved-issues-5"> <span id="id62"></span><h3>Resolved issues<a class="headerlink" href="#resolved-issues-5" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Python 3.5 and Python 3.7 are now supported.</p></li> </ul> </div> <div class="section" id="known-issues-and-limitations-3"> <span id="id63"></span><h3>Known issues and limitations<a class="headerlink" href="#known-issues-and-limitations-3" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="other-notes"> <h3>Other Notes<a class="headerlink" href="#other-notes" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="neuron-torch-106270"> <span id="id64"></span><h2><a class="toc-backref" href="#id102">[1.0.627.0]</a><a class="headerlink" href="#neuron-torch-106270" title="Permalink to this headline">#</a></h2> <p>Date: 12/20/2019</p> <div class="section" id="summary-9"> <span id="id65"></span><h3>Summary<a class="headerlink" href="#summary-9" title="Permalink to this headline">#</a></h3> <p>This is the initial release of torch-neuron. It is not distributed on the DLAMI yet and needs to be installed from the neuron pip repository.</p> <p>Note that we are currently using a TensorFlow as an intermediate format to pass to our compiler. This does not affect any runtime execution from PyTorch to Neuron Runtime and Inferentia. This is why the neuron-cc installation must include [tensorflow] for PyTorch.</p> </div> <div class="section" id="major-new-features-6"> <span id="id66"></span><h3>Major new features<a class="headerlink" href="#major-new-features-6" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="resolved-issues-6"> <span id="id67"></span><h3>Resolved issues<a class="headerlink" href="#resolved-issues-6" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="known-issues-and-limitations-4"> <span id="id68"></span><h3>Known issues and limitations<a class="headerlink" href="#known-issues-and-limitations-4" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="models-tested"> <h3>Models TESTED<a class="headerlink" href="#models-tested" title="Permalink to this headline">#</a></h3> <p>The following models have successfully run on neuron-inferentia systems</p> <ol class="arabic simple"> <li><p>SqueezeNet</p></li> <li><p>ResNet50</p></li> <li><p>Wide ResNet50</p></li> </ol> </div> <div class="section" id="pytorch-serving"> <h3>Pytorch Serving<a class="headerlink" href="#pytorch-serving" title="Permalink to this headline">#</a></h3> <p>In this initial version there is no specific serving support. Inference works correctly through Python on Inf1 instances using the neuron runtime. Future releases will include support for production deployment and serving of models</p> </div> <div class="section" id="profiler-support"> <h3>Profiler support<a class="headerlink" href="#profiler-support" title="Permalink to this headline">#</a></h3> <p>Profiler support is not provided in this initial release and will be available in future releases</p> </div> <div class="section" id="automated-partitioning"> <h3>Automated partitioning<a class="headerlink" href="#automated-partitioning" title="Permalink to this headline">#</a></h3> <p>Automatic partitioning of graphs into supported and non-supported operations is not currently supported. A tutorial is available to provide guidance on how to manually parition a model graph. Please see <span class="xref std std-ref">pytorch-manual-partitioning-jn-tutorial</span></p> </div> <div class="section" id="pytorch-dependency"> <h3>PyTorch dependency<a class="headerlink" href="#pytorch-dependency" title="Permalink to this headline">#</a></h3> <p>Currently PyTorch support depends on a Neuron specific version of PyTorch v1.3.1. Future revisions will add support for 1.4 and future releases.</p> </div> <div class="section" id="trace-behavior"> <h3>Trace behavior<a class="headerlink" href="#trace-behavior" title="Permalink to this headline">#</a></h3> <p>In order to trace a model it must be in evaluation mode. For examples please see <a class="reference internal" href="../../../src/examples/pytorch/resnet50.html"><span class="std std-ref">ResNet50 model for Inferentia</span></a></p> </div> <div class="section" id="six-pip-package-is-required"> <h3>Six pip package is required<a class="headerlink" href="#six-pip-package-is-required" title="Permalink to this headline">#</a></h3> <p>The Six package is required for the torch-neuron runtime, but it is not modeled in the package dependencies. This will be fixed in a future release.</p> </div> <div class="section" id="multiple-neuroncore-support"> <h3>Multiple NeuronCore support<a class="headerlink" href="#multiple-neuroncore-support" title="Permalink to this headline">#</a></h3> <p>If the num-neuroncores options is used the number of cores must be manually set in the calling shell environment variable for compilation and inference.</p> <p>For example: Using the keyword argument compiler_args=[‘—num-neuroncores’, ‘4’] in the trace call, requires NEURONCORE_GROUP_SIZES=4 to be set in the environment at compile time and runtime</p> </div> <div class="section" id="cpu-execution"> <h3>CPU execution<a class="headerlink" href="#cpu-execution" title="Permalink to this headline">#</a></h3> <p>At compilation time a constant output is generated for the purposes of tracing. Running inference on a non neuron instance will generate incorrect results. This must not be used. The following error message is generated to stderr:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ne">Warning</span><span class="p">:</span> <span class="n">Tensor</span> <span class="n">output</span> <span class="n">are</span> <span class="o">**</span> <span class="n">NOT</span> <span class="n">CALCULATED</span> <span class="o">**</span> <span class="n">during</span> <span class="n">CPU</span> <span class="n">execution</span> <span class="ow">and</span> <span class="n">only</span> <span class="n">indicate</span> <span class="n">tensor</span> <span class="n">shape</span> </pre></div> </div> </div> <div class="section" id="other-notes-1"> <span id="id69"></span><h3>Other notes<a class="headerlink" href="#other-notes-1" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Python version(s) supported:</p> <ul> <li><p>3.6</p></li> </ul> </li> <li><p>Linux distribution supported:</p> <ul> <li><p>DLAMI Ubuntu 18 and Amazon Linux 2 (using Python 3.6 Conda environments)</p></li> <li><p>Other AMIs based on Ubuntu 18</p></li> <li><p>For Amazon Linux 2 please install Conda and use Python 3.6 Conda environment</p></li> </ul> </li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Troubleshooting Guide for PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../frameworks/torch/training-torch-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Training (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:03.193Z
Tutorials for Training(torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html
# Tutorials for Training(torch-neuronx) — AWS Neuron Documentation next Hugging Face BERT Pretraining Tutorial
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Tutorials for Training(torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Hugging Face BERT Pretraining Tutorial" href="bert.html"> <link rel="prev" title="Training (torch-neuronx)" href="../../../training-torch-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Tutorials for Training(torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="tutorials-for-training-torch-neuronx"> <h1>Tutorials for Training(torch-neuronx)<a class="headerlink" href="#tutorials-for-training-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="bert.html#hf-bert-pretraining-tutorial"><span class="std std-ref">Hugging Face BERT Pretraining Tutorial</span></a></p></li> <li><p><a class="reference internal" href="mlp.html#neuronx-mlp-training-tutorial"><span class="std std-ref">Multi-Layer Perceptron Training Tutorial</span></a></p></li> <li><p><a class="reference internal" href="finetune_hftrainer.html#torch-hf-bert-finetune"><span class="std std-ref">PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API</span></a></p></li> <li><p><a class="reference internal" href="finetune_t5.html#torch-hf-t5-finetune"><span class="std std-ref">Fine-tune T5 model on Trn1</span></a></p></li> <li><p><a class="reference internal" href="zero1_gpt2.html#zero1-gpt2-pretraining-tutorial"><span class="std std-ref">ZeRO-1 Tutorial</span></a></p></li> <li><p><a class="reference internal" href="analyze_for_training.html#torch-analyze-for-training-tutorial"><span class="std std-ref">Analyze for Training Tutorial</span></a></p></li> <li><p><a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html#neuronx-customop-mlp-tutorial"><span class="std std-ref">Neuron Custom C++ Operators in MLP Training</span></a></p></li> <li><p><a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html#neuronx-customop-mlp-perf"><span class="std std-ref">Neuron Custom C++ Operators Performance Optimization</span></a></p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p>To use Jupyter Notebook see:</p> <ul class="simple"> <li><p><a class="reference internal" href="../../../../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p><a class="reference internal" href="../../../../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../training-torch-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Training (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="bert.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Hugging Face BERT Pretraining Tutorial</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:03.826Z
Multi-Layer Perceptron Training Tutorial — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/mlp.html
# Multi-Layer Perceptron Training Tutorial — AWS Neuron Documentation ## Multi-Layer Perceptron Training Tutorial[#](#multi-layer-perceptron-training-tutorial "Permalink to this headline") MNIST is a standard dataset for handwritten digit recognition. A multi-layer perceptron (MLP) model can be trained with MNIST dataset to recognize hand-written digits. This tutorial starts with a 3-layer MLP training example in PyTorch on CPU, then show how to modify it to run on Trainium using PyTorch Neuron. It also shows how to do multiple worker data parallel MLP training. Table of Contents - [Setup environment and download examples](#setup-environment-and-download-examples) - [Multi-layer perceptron MNIST model](#multi-layer-perceptron-mnist-model) - [Single-worker MLP training script in PyTorch on CPU](#single-worker-mlp-training-script-in-pytorch-on-cpu) - [Single-worker MLP training on Trainium](#single-worker-mlp-training-on-trainium) - [Multi-worker data-parallel MLP training using torchrun](#multi-worker-data-parallel-mlp-training-using-torchrun) - [Single-worker MLP evaluation on Trainium](#single-worker-mlp-evaluation-on-trainium) - [Known issues and limitations](#known-issues-and-limitations) Note Logs used in tutorials do not present latest performance numbers For latest performance numbers visit [Neuron Performance](../../../../../general/benchmarks/index.html#benchmark) ## [Setup environment and download examples](#id1)[#](#setup-environment-and-download-examples "Permalink to this headline") Before running the tutorial please follow the installation instructions at: [Install PyTorch Neuron on Trn1](../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx) Please set the storage of instance to _512GB_ or more if you also want to run through the BERT pretraining and GPT pretraining tutorials. For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands: ``` source ~/aws_neuron_venv_pytorch/bin/activate ``` Install needed dependencies in your environment by running: Torchvision package is needed for MNIST dataset and has already been installed as part of [Install PyTorch Neuron on Trn1](../../setup/pytorch-install.html#pytorch-neuronx-install). Installing Torchvision together with torch-neuronx ensures that the compatible version of Torchvision is selected. For example, torchvision==0.12 is compatible with torch==1.11 and torchvision==0.13 is compatible with torch==1.12. To download the MNIST MLP examples, do: ``` git clone https://github.com/aws-neuron/aws-neuron-samples.git cd aws-neuron-samples/torch-neuronx/training/mnist_mlp ``` ## [Multi-layer perceptron MNIST model](#id2)[#](#multi-layer-perceptron-mnist-model "Permalink to this headline") In `model.py`, we define the multi-layer perceptron (MLP) MNIST model with 3 linear layers and ReLU activations, followed by a log-softmax layer. This model will be used in multiple example scripts. ## [Single-worker MLP training script in PyTorch on CPU](#id3)[#](#single-worker-mlp-training-script-in-pytorch-on-cpu "Permalink to this headline") We will show how to modify a training script that runs on other platform to run on Trainium. We begin with a single-worker MLP training script for running on the host CPUs of the Trainium instance. The training script imports the MLP model from `model.py`. In this training script, we load the MNIST train dataset and, within the `main()` method, set the data loader to read batches of 32 training examples and corresponding labels. Next we instantiate the MLP model and move it to the device. We use `device = 'cpu'` to illustrate the use of device in PyTorch. On GPU you would use `device = 'cuda'` instead. We also instantiate the other two components of a neural network trainer: stochastic-gradient-descent (SGD) optimizer and negative-log-likelihood (NLL) loss function (also known as cross-entropy loss). After the optimizer and loss function, we create a training loop to iterate over the training samples and labels, performing the following steps for each batch in each iteration: - Zero gradients using: - Move training samples and labels to device using the ‘tensor.to’ method. - Perform forward/prediction pass using - The prediction results are compared against the corresponding labels using the loss function to compute the loss ``` loss_fn(output, train_label) ``` - The loss is propagated back through the model using chain-rule to compute the weight gradients - The weights are updated with a change that is proportional to the computed weights gradients At the end of training we compute the throughput, display the final loss and save the checkpoint. Expected CPU output: ``` ----------Training --------------- Train throughput (iter/sec): 286.96994718801335 Final loss is 0.1040 ----------End Training --------------- ``` For a full tutorial on training in PyTorch, please see [https://pytorch.org/tutorials/beginner/introyt/trainingyt.html](https://pytorch.org/tutorials/beginner/introyt/trainingyt.html). Thus far we have used PyTorch without Trainium. Next, we will show how to change this script to run on Trainium. ## [Single-worker MLP training on Trainium](#id4)[#](#single-worker-mlp-training-on-trainium "Permalink to this headline") To run on Trainium, first we modify the CPU training script train\_cpu.py to run with PyTorch Neuron torch\_xla as described in [PyTorch Neuron for Trainium Getting Started Guide](../../programming-guide/training/pytorch-neuron-programming-guide.html#pytorch-neuronx-programming-guide) by changing the device: ``` import torch_xla.core.xla_model as xm device = xm.xla_device() # or device = 'xla' ``` When the model is moved to the XLA device using `model.to(device)` method, subsequent operations on the model are recorded for later execution. This is XLA’s lazy execution which is different from PyTorch’s eager execution. Within the training loop, we must mark the graph to be optimized and run on XLA device (NeuronCore) using xm.mark\_step() (unless MpDeviceLoader is used as you will see in the next section). Without this mark, XLA cannot determine where the graph ends. The collected computational graph also gets compiled and executed when you request the value of a tensor such as by calling `loss.item()` or `print(loss)`. To save a checkpoint, it is recommended to use the `xm.save()` function instead of `torch.save()` to ensure states are moved to CPU. `xm.save()` also prevents the “XRT memory handle not found” warning at the end of evaluation script (if the checkpoint saved using torch.save() is used for evaluation). The resulting script `train.py` can be executed as `python3 train.py`. Again, note that we import the MLP model from `model.py`. When you examine the script, the comments that begin with ‘XLA’ indicate the changes required to make the script compatible with torch\_xla. Expected output on trn1.32xlarge (start from a fresh compilation cache, located at /var/tmp/neuron-compile-cache by default): ``` 2022-04-12 16:15:00.000947: INFO ||NCC_WRAPPER||: No candidate found under /var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_18200615679846498221. 2022-04-12 16:15:00.000949: INFO ||NCC_WRAPPER||: Cache dir for the neff: /var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_18200615679846498221/MODULE_0_SyncTensorsGraph.318_18200615679846498221_ip-172-31-69-14.ec2.internal-8355221-28940-5dc775cd78aa2/83a0fd4a-b07e-4404-aa55-701ab3b2700c ........ Compiler status PASS 2022-04-12 16:18:05.000843: INFO ||NCC_WRAPPER||: Exiting with a successfully compiled graph 2022-04-12 16:18:05.000957: INFO ||NCC_WRAPPER||: No candidate found under /var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_5000680699473283909. 2022-04-12 16:18:05.000960: INFO ||NCC_WRAPPER||: Cache dir for the neff: /var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_5000680699473283909/MODULE_1_SyncTensorsGraph.390_5000680699473283909_ip-172-31-69-14.ec2.internal-8355221-28940-5dc7767e5fc69/7d0a2955-11b4-42e6-b536-6f0f02cc68df . Compiler status PASS 2022-04-12 16:18:12.000912: INFO ||NCC_WRAPPER||: Exiting with a successfully compiled graph ----------Training --------------- Train throughput (iter/sec): 95.06756661972014 Final loss is 0.1979 ----------End Training --------------- ``` If you re-run the training script a second time, you will see messages indicating that the compiled graphs are cached in the persistent cache from the previous run and that the startup time is quicker: ``` (aws_neuron_venv_pytorch_p36) [ec2-user@ip-172-31-69-14 mnist_mlp]$ python train.py |& tee log_trainium 2022-04-12 16:21:58.000241: INFO ||NCC_WRAPPER||: Using a cached neff at /var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_18200615679846498221/MODULE_0_SyncTensorsGraph.318_18200615679846498221_ip-172-31-69-14.ec2.internal-8355221-28940-5dc775cd78aa2/83a0fd4a-b07e-4404-aa55-701ab3b2700c/MODULE_0_SyncTensorsGraph.318_18200615679846498221_ip-172-31-69-14.ec2.internal-8355221-28940-5dc775cd78aa2.neff. Exiting with a successfully compiled graph 2022-04-12 16:21:58.000342: INFO ||NCC_WRAPPER||: Using a cached neff at /var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_5000680699473283909/MODULE_1_SyncTensorsGraph.390_5000680699473283909_ip-172-31-69-14.ec2.internal-8355221-28940-5dc7767e5fc69/7d0a2955-11b4-42e6-b536-6f0f02cc68df/MODULE_1_SyncTensorsGraph.390_5000680699473283909_ip-172-31-69-14.ec2.internal-8355221-28940-5dc7767e5fc69.neff. Exiting with a successfully compiled graph ----------Training --------------- Train throughput (iter/sec): 93.16748895384832 Final loss is 0.1979 ----------End Training --------------- ``` Multiple graphs can be created during execution since there are differences between some iterations (first, steady state, last). After the first iteration, the graph for each iteration should remain the same from iteration to iteration. This allows XLA runtime to execute a previous compiled graph that has been cached in XLA runtime cache. If the inner training loop has some control-flows, for example for gradient accumulation, the number of compiled graphs may increase due to the generation and consumption of intermediates as well as additional operations when the conditional path is taken. ## [Multi-worker data-parallel MLP training using torchrun](#id5)[#](#multi-worker-data-parallel-mlp-training-using-torchrun "Permalink to this headline") Data parallel training allows you to replicate your script across multiple workers, each worker processing a proportional portion of the dataset, in order to train faster. The PyTorch distributed utility torchrun can be used to launch multiple processes in a server node for multi-worker data parallel training. To run multiple workers in data parallel configuration using torchrun, modify the single-worker training script train.py as follows (below we use `xm` as alias for `torch_xla.core.xla_model` and `xmp` as alias for `torch_xla.distributed.xla_multiprocessing`): 1. Import XLA backend for torch.distributed using `import torch_xla.distributed.xla_backend`. 2. Use `torch.distributed.init_process_group('xla')` to initialize PyTorch XLA runtime and Neuron runtime. 3. Use XLA multiprocessing device loader (`MpDeviceLoader`) from `torch_xla.distributed` to wrap PyTorch data loader. 4. Use `xm.optimizer_step(optimizer)` to perform allreduce and take optimizer step. XLA MpDeviceLoader is optimized for XLA and is recommended for best performance. It also takes care of marking the step for execution (compile and execute the lazily collected operations for an iteration) so no separate `xm.mark_step()` is needed. The following are general best-practice changes needed to scale up the training: 1. Set the random seed to be the same across workers. 2. Scale up the learning rate by the number of workers. Use `xm.xrt_world_size()` to get the global number of workers. 3. Add distributed sampler to allow different worker to sample different portions of dataset. Also, the `xm.save()` function used to save checkpoint automatically saves only for the rank-0 worker’s parameters. The resulting script is `train_torchrun.py` (note again that we import the MLP model from `model.py`): Next we use the `torchrun` utility that is included with torch installation to run multiple processes, each using one NeuronCore. Use the option `nproc_per_node` to indicate the number of processes to launch. For example, to run on two NeuronCores on one Trn1 instance only, do: ``` torchrun --nproc_per_node=2 train_torchrun.py ``` NOTE: Currently we only support 1 and 2 worker configurations on trn1.2xlarge and 1, 2, 8, and 32-worker configurations on trn1.32xlarge. Expected output on trn1.32xlarge (second run to avoid compilations): ``` ----------Training --------------- ----------Training --------------- ... (Info messages truncated) Train throughput (iter/sec): 163.25353269069706 Train throughput (iter/sec): 163.23261047441036 Final loss is 0.3469 Final loss is 0.1129 ----------End Training --------------- ----------End Training --------------- ``` In another example, we run on two trn1.32xlarge instances launched with EFA-enabled interfaces, using [EFA-enabled security group](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa-start-nccl-base.html#nccl-start-base-setup), and setup using [Install PyTorch Neuron on Trn1](../../setup/pytorch-install.html#pytorch-neuronx-install). NOTE: To run on multiple instances, you will need to use trn1.32xlarge instances and using all 32 NeuronCores on each instance. On the rank-0 Trn1 host (root), run with `--node_rank=0` using torchrun utility, and `--master_addr` set to rank-0 host’s IP address: ``` export FI_EFA_USE_DEVICE_RDMA=1 export FI_PROVIDER=efa torchrun --nproc_per_node=32 --nnodes=2 --node_rank=0 --master_addr=<root IP> --master_port=2020 train_torchrun.py ``` On another Trn1 host, run with `--node_rank=1`, and `--master_addr` also set to rank-0 host’s IP address: ``` export FI_EFA_USE_DEVICE_RDMA=1 export FI_PROVIDER=efa torchrun --nproc_per_node=32 --nnodes=2 --node_rank=1 --master_addr=<root IP> --master_port=2020 train_torchrun.py ``` It is important to launch rank-0 worker with `--node_rank=0` to avoid hang. To train on multiple instances, it is recommended to use a ParallelCluster. For a ParallelCluster example, please see [Train a model on AWS Trn1 ParallelCluster](https://github.com/aws-neuron/aws-neuron-parallelcluster-samples). ## [Single-worker MLP evaluation on Trainium](#id6)[#](#single-worker-mlp-evaluation-on-trainium "Permalink to this headline") After training, the final checkpoint is saved in `checkpoints` directory. You can run the evaluation step by running the `eval.py` script in the same directory as the training script: ``` cd ~/aws-neuron-samples/torch-neuronx/training/mnist_mlp python eval.py ``` This evaluation phase can be merged with the training script to check accuracy, for example at the end of every epoch. It is kept separate for illustration purpose. The evaluation script follow similar flow as the training script with the following differences: - The input data used is the validation subset of the MNIST dataset. - Only need to loop through the dataset once (no epochs). - There’s only forward pass through the model, and no backward pass or optimizer update. - Compute the accuracy across validation set instead of loss per batch. Expected results (after a second execution to eliminate warmup compilation time during first execution): ``` ----------Evaluating--------------- Test throughput (iter/sec): 47.897945949832845 Accuracy: 0.9273833632469177 ----------Done Evaluating--------------- ``` If you get a lower accuracy than above, please check that the training is done with at least 4 epochs. You can also use [PyTorch Neuron (torch-neuronx) Tracing API for Inference](../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch-neuronx-trace-api) in the evaluation loop. This can be achieved by the following changes to the `eval.py`: - Use `device = 'cpu'` instead of XLA device. - Don’t use `mark_step()`. - Trace the model at the first iteration to freeze it and precompile for inference: ``` if idx == 0: import torch_neuronx model = torch_neuronx.trace(model, test_x) ``` However, note that the inference trace API fixed the input tensor shape, so that every input tensor will need to match the size used during the tracing step. To ensure every batch from `DataLoader` has the same tensor shape, pass `drop_last=True` option when instantiating `DataLoader`. ``` test_loader = DataLoader(test_dataset, batch_size=32, drop_last=True) ``` The script `eval_using_trace.py` can be compared against `eval.py` to show the above modifications. It can be executed using: ``` python eval_using_trace.py ``` Expected results (note the large increase in performance when using trace API for inference): ``` ----------Evaluating--------------- Test throughput (iter/sec): 409.0836291417652 Accuracy: 0.9288585186004639 ----------Done Evaluating--------------- ``` ## [Known issues and limitations](#id7)[#](#known-issues-and-limitations "Permalink to this headline") MLP model is not optimized for performance. For the single-worker training, the performance can be improved by using MpDeviceLoader which exists in the multiprocessing example. For example, by setting `--nproc_per_node=1` in the torchrun example, you will see higher MLP performance. ``` (aws_neuron_venv_pytorch_p36) [ec2-user@ip-172-31-69-14 mnist_mlp]$ torchrun --nproc_per_node=1 train_torchrun.py ----------Training --------------- ... (Info messages truncated) Train throughput (iter/sec): 192.43508922834008 Final loss is 0.2720 ----------End Training --------------- ``` _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Multi-Layer Perceptron Training Tutorial — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API" href="finetune_hftrainer.html"> <link rel="prev" title="Hugging Face BERT Pretraining Tutorial" href="bert.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/tutorials/training/mlp", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-training-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/tutorials/training/mlp.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/mlp.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/tutorials/training/mlp.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-environment-and-download-examples"> Setup environment and download examples </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-layer-perceptron-mnist-model"> Multi-layer perceptron MNIST model </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-mlp-training-script-in-pytorch-on-cpu"> Single-worker MLP training script in PyTorch on CPU </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-mlp-training-on-trainium"> Single-worker MLP training on Trainium </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-worker-data-parallel-mlp-training-using-torchrun"> Multi-worker data-parallel MLP training using torchrun </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-mlp-evaluation-on-trainium"> Single-worker MLP evaluation on Trainium </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known issues and limitations </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Multi-Layer Perceptron Training Tutorial</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-environment-and-download-examples"> Setup environment and download examples </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-layer-perceptron-mnist-model"> Multi-layer perceptron MNIST model </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-mlp-training-script-in-pytorch-on-cpu"> Single-worker MLP training script in PyTorch on CPU </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-mlp-training-on-trainium"> Single-worker MLP training on Trainium </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-worker-data-parallel-mlp-training-using-torchrun"> Multi-worker data-parallel MLP training using torchrun </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-mlp-evaluation-on-trainium"> Single-worker MLP evaluation on Trainium </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known issues and limitations </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="multi-layer-perceptron-training-tutorial"> <span id="neuronx-mlp-training-tutorial"></span><h1>Multi-Layer Perceptron Training Tutorial<a class="headerlink" href="#multi-layer-perceptron-training-tutorial" title="Permalink to this headline">#</a></h1> <p>MNIST is a standard dataset for handwritten digit recognition. A multi-layer perceptron (MLP) model can be trained with MNIST dataset to recognize hand-written digits. This tutorial starts with a 3-layer MLP training example in PyTorch on CPU, then show how to modify it to run on Trainium using PyTorch Neuron. It also shows how to do multiple worker data parallel MLP training.</p> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#setup-environment-and-download-examples" id="id1">Setup environment and download examples</a></p></li> <li><p><a class="reference internal" href="#multi-layer-perceptron-mnist-model" id="id2">Multi-layer perceptron MNIST model</a></p></li> <li><p><a class="reference internal" href="#single-worker-mlp-training-script-in-pytorch-on-cpu" id="id3">Single-worker MLP training script in PyTorch on CPU</a></p></li> <li><p><a class="reference internal" href="#single-worker-mlp-training-on-trainium" id="id4">Single-worker MLP training on Trainium</a></p></li> <li><p><a class="reference internal" href="#multi-worker-data-parallel-mlp-training-using-torchrun" id="id5">Multi-worker data-parallel MLP training using torchrun</a></p></li> <li><p><a class="reference internal" href="#single-worker-mlp-evaluation-on-trainium" id="id6">Single-worker MLP evaluation on Trainium</a></p></li> <li><p><a class="reference internal" href="#known-issues-and-limitations" id="id7">Known issues and limitations</a></p></li> </ul> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Logs used in tutorials do not present latest performance numbers</p> <p>For latest performance numbers visit <a class="reference internal" href="../../../../../general/benchmarks/index.html#benchmark"><span class="std std-ref">Neuron Performance</span></a></p> </div> <div class="section" id="setup-environment-and-download-examples"> <h2><a class="toc-backref" href="#id1">Setup environment and download examples</a><a class="headerlink" href="#setup-environment-and-download-examples" title="Permalink to this headline">#</a></h2> <p>Before running the tutorial please follow the installation instructions at:</p> <p><a class="reference internal" href="../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx"><span class="std std-ref">Install PyTorch Neuron on Trn1</span></a></p> <p>Please set the storage of instance to <em>512GB</em> or more if you also want to run through the BERT pretraining and GPT pretraining tutorials.</p> <p>For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>~/aws_neuron_venv_pytorch/bin/activate </pre></div> </div> <p>Install needed dependencies in your environment by running:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>pillow </pre></div> </div> <p>Torchvision package is needed for MNIST dataset and has already been installed as part of <a class="reference internal" href="../../setup/pytorch-install.html#pytorch-neuronx-install"><span class="std std-ref">Install PyTorch Neuron on Trn1</span></a>. Installing Torchvision together with torch-neuronx ensures that the compatible version of Torchvision is selected. For example, torchvision==0.12 is compatible with torch==1.11 and torchvision==0.13 is compatible with torch==1.12.</p> <p>To download the MNIST MLP examples, do:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/aws-neuron/aws-neuron-samples.git <span class="nb">cd</span><span class="w"> </span>aws-neuron-samples/torch-neuronx/training/mnist_mlp </pre></div> </div> </div> <div class="section" id="multi-layer-perceptron-mnist-model"> <h2><a class="toc-backref" href="#id2">Multi-layer perceptron MNIST model</a><a class="headerlink" href="#multi-layer-perceptron-mnist-model" title="Permalink to this headline">#</a></h2> <p>In <code class="docutils literal notranslate"><span class="pre">model.py</span></code>, we define the multi-layer perceptron (MLP) MNIST model with 3 linear layers and ReLU activations, followed by a log-softmax layer. This model will be used in multiple example scripts.</p> </div> <div class="section" id="single-worker-mlp-training-script-in-pytorch-on-cpu"> <h2><a class="toc-backref" href="#id3">Single-worker MLP training script in PyTorch on CPU</a><a class="headerlink" href="#single-worker-mlp-training-script-in-pytorch-on-cpu" title="Permalink to this headline">#</a></h2> <p>We will show how to modify a training script that runs on other platform to run on Trainium.</p> <p>We begin with a single-worker MLP training script for running on the host CPUs of the Trainium instance. The training script imports the MLP model from <code class="docutils literal notranslate"><span class="pre">model.py</span></code>.</p> <p>In this training script, we load the MNIST train dataset and, within the <code class="docutils literal notranslate"><span class="pre">main()</span></code> method, set the data loader to read batches of 32 training examples and corresponding labels.</p> <p>Next we instantiate the MLP model and move it to the device. We use <code class="docutils literal notranslate"><span class="pre">device</span> <span class="pre">=</span> <span class="pre">'cpu'</span></code> to illustrate the use of device in PyTorch. On GPU you would use <code class="docutils literal notranslate"><span class="pre">device</span> <span class="pre">=</span> <span class="pre">'cuda'</span></code> instead.</p> <p>We also instantiate the other two components of a neural network trainer: stochastic-gradient-descent (SGD) optimizer and negative-log-likelihood (NLL) loss function (also known as cross-entropy loss).</p> <p>After the optimizer and loss function, we create a training loop to iterate over the training samples and labels, performing the following steps for each batch in each iteration:</p> <ul class="simple"> <li><p>Zero gradients using:</p></li> </ul> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">optimizer</span><span class="o">.</span><span class="n">zero_grad</span><span class="p">()</span> </pre></div> </div> <ul class="simple"> <li><p>Move training samples and labels to device using the ‘tensor.to’ method.</p></li> <li><p>Perform forward/prediction pass using</p></li> </ul> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">output</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">train_x</span><span class="p">)</span> </pre></div> </div> <ul class="simple"> <li><p>The prediction results are compared against the corresponding labels using the loss function to compute the loss</p></li> </ul> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">loss_fn</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">train_label</span><span class="p">)</span> </pre></div> </div> <ul class="simple"> <li><p>The loss is propagated back through the model using chain-rule to compute the weight gradients</p></li> </ul> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">loss</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span> </pre></div> </div> <ul class="simple"> <li><p>The weights are updated with a change that is proportional to the computed weights gradients</p></li> </ul> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">optimizer</span><span class="o">.</span><span class="n">step</span><span class="p">()</span> </pre></div> </div> <p>At the end of training we compute the throughput, display the final loss and save the checkpoint.</p> <p>Expected CPU output:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>----------Training<span class="w"> </span>--------------- Train<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">286</span>.96994718801335 Final<span class="w"> </span>loss<span class="w"> </span>is<span class="w"> </span><span class="m">0</span>.1040 ----------End<span class="w"> </span>Training<span class="w"> </span>--------------- </pre></div> </div> <p>For a full tutorial on training in PyTorch, please see <a class="reference external" href="https://pytorch.org/tutorials/beginner/introyt/trainingyt.html">https://pytorch.org/tutorials/beginner/introyt/trainingyt.html</a>.</p> <p>Thus far we have used PyTorch without Trainium. Next, we will show how to change this script to run on Trainium.</p> </div> <div class="section" id="single-worker-mlp-training-on-trainium"> <h2><a class="toc-backref" href="#id4">Single-worker MLP training on Trainium</a><a class="headerlink" href="#single-worker-mlp-training-on-trainium" title="Permalink to this headline">#</a></h2> <p>To run on Trainium, first we modify the CPU training script train_cpu.py to run with PyTorch Neuron torch_xla as described in <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html#pytorch-neuronx-programming-guide"><span class="std std-ref">PyTorch Neuron for Trainium Getting Started Guide</span></a> by changing the device:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="c1"># or</span> <span class="n">device</span> <span class="o">=</span> <span class="s1">'xla'</span> </pre></div> </div> <p>When the model is moved to the XLA device using <code class="docutils literal notranslate"><span class="pre">model.to(device)</span></code> method, subsequent operations on the model are recorded for later execution. This is XLA’s lazy execution which is different from PyTorch’s eager execution. Within the training loop, we must mark the graph to be optimized and run on XLA device (NeuronCore) using xm.mark_step() (unless MpDeviceLoader is used as you will see in the next section). Without this mark, XLA cannot determine where the graph ends. The collected computational graph also gets compiled and executed when you request the value of a tensor such as by calling <code class="docutils literal notranslate"><span class="pre">loss.item()</span></code> or <code class="docutils literal notranslate"><span class="pre">print(loss)</span></code>.</p> <p>To save a checkpoint, it is recommended to use the <code class="docutils literal notranslate"><span class="pre">xm.save()</span></code> function instead of <code class="docutils literal notranslate"><span class="pre">torch.save()</span></code> to ensure states are moved to CPU. <code class="docutils literal notranslate"><span class="pre">xm.save()</span></code> also prevents the “XRT memory handle not found” warning at the end of evaluation script (if the checkpoint saved using torch.save() is used for evaluation).</p> <p>The resulting script <code class="docutils literal notranslate"><span class="pre">train.py</span></code> can be executed as <code class="docutils literal notranslate"><span class="pre">python3</span> <span class="pre">train.py</span></code>. Again, note that we import the MLP model from <code class="docutils literal notranslate"><span class="pre">model.py</span></code>. When you examine the script, the comments that begin with ‘XLA’ indicate the changes required to make the script compatible with torch_xla.</p> <p>Expected output on trn1.32xlarge (start from a fresh compilation cache, located at /var/tmp/neuron-compile-cache by default):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">2022</span>-04-12<span class="w"> </span><span class="m">16</span>:15:00.000947:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>No<span class="w"> </span>candidate<span class="w"> </span>found<span class="w"> </span>under<span class="w"> </span>/var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_18200615679846498221. <span class="m">2022</span>-04-12<span class="w"> </span><span class="m">16</span>:15:00.000949:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Cache<span class="w"> </span>dir<span class="w"> </span><span class="k">for</span><span class="w"> </span>the<span class="w"> </span>neff:<span class="w"> </span>/var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_18200615679846498221/MODULE_0_SyncTensorsGraph.318_18200615679846498221_ip-172-31-69-14.ec2.internal-8355221-28940-5dc775cd78aa2/83a0fd4a-b07e-4404-aa55-701ab3b2700c ........ Compiler<span class="w"> </span>status<span class="w"> </span>PASS <span class="m">2022</span>-04-12<span class="w"> </span><span class="m">16</span>:18:05.000843:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Exiting<span class="w"> </span>with<span class="w"> </span>a<span class="w"> </span>successfully<span class="w"> </span>compiled<span class="w"> </span>graph <span class="m">2022</span>-04-12<span class="w"> </span><span class="m">16</span>:18:05.000957:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>No<span class="w"> </span>candidate<span class="w"> </span>found<span class="w"> </span>under<span class="w"> </span>/var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_5000680699473283909. <span class="m">2022</span>-04-12<span class="w"> </span><span class="m">16</span>:18:05.000960:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Cache<span class="w"> </span>dir<span class="w"> </span><span class="k">for</span><span class="w"> </span>the<span class="w"> </span>neff:<span class="w"> </span>/var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_5000680699473283909/MODULE_1_SyncTensorsGraph.390_5000680699473283909_ip-172-31-69-14.ec2.internal-8355221-28940-5dc7767e5fc69/7d0a2955-11b4-42e6-b536-6f0f02cc68df . Compiler<span class="w"> </span>status<span class="w"> </span>PASS <span class="m">2022</span>-04-12<span class="w"> </span><span class="m">16</span>:18:12.000912:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Exiting<span class="w"> </span>with<span class="w"> </span>a<span class="w"> </span>successfully<span class="w"> </span>compiled<span class="w"> </span>graph ----------Training<span class="w"> </span>--------------- Train<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">95</span>.06756661972014 Final<span class="w"> </span>loss<span class="w"> </span>is<span class="w"> </span><span class="m">0</span>.1979 ----------End<span class="w"> </span>Training<span class="w"> </span>--------------- </pre></div> </div> <p>If you re-run the training script a second time, you will see messages indicating that the compiled graphs are cached in the persistent cache from the previous run and that the startup time is quicker:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">(</span>aws_neuron_venv_pytorch_p36<span class="o">)</span><span class="w"> </span><span class="o">[</span>ec2-user@ip-172-31-69-14<span class="w"> </span>mnist_mlp<span class="o">]</span>$<span class="w"> </span>python<span class="w"> </span>train.py<span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>log_trainium <span class="m">2022</span>-04-12<span class="w"> </span><span class="m">16</span>:21:58.000241:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Using<span class="w"> </span>a<span class="w"> </span>cached<span class="w"> </span>neff<span class="w"> </span>at<span class="w"> </span>/var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_18200615679846498221/MODULE_0_SyncTensorsGraph.318_18200615679846498221_ip-172-31-69-14.ec2.internal-8355221-28940-5dc775cd78aa2/83a0fd4a-b07e-4404-aa55-701ab3b2700c/MODULE_0_SyncTensorsGraph.318_18200615679846498221_ip-172-31-69-14.ec2.internal-8355221-28940-5dc775cd78aa2.neff.<span class="w"> </span>Exiting<span class="w"> </span>with<span class="w"> </span>a<span class="w"> </span>successfully<span class="w"> </span>compiled<span class="w"> </span>graph <span class="m">2022</span>-04-12<span class="w"> </span><span class="m">16</span>:21:58.000342:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Using<span class="w"> </span>a<span class="w"> </span>cached<span class="w"> </span>neff<span class="w"> </span>at<span class="w"> </span>/var/tmp/neuron-compile-cache/USER_neuroncc-1.0.47218.0+162039557/MODULE_5000680699473283909/MODULE_1_SyncTensorsGraph.390_5000680699473283909_ip-172-31-69-14.ec2.internal-8355221-28940-5dc7767e5fc69/7d0a2955-11b4-42e6-b536-6f0f02cc68df/MODULE_1_SyncTensorsGraph.390_5000680699473283909_ip-172-31-69-14.ec2.internal-8355221-28940-5dc7767e5fc69.neff.<span class="w"> </span>Exiting<span class="w"> </span>with<span class="w"> </span>a<span class="w"> </span>successfully<span class="w"> </span>compiled<span class="w"> </span>graph ----------Training<span class="w"> </span>--------------- Train<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">93</span>.16748895384832 Final<span class="w"> </span>loss<span class="w"> </span>is<span class="w"> </span><span class="m">0</span>.1979 ----------End<span class="w"> </span>Training<span class="w"> </span>--------------- </pre></div> </div> <p>Multiple graphs can be created during execution since there are differences between some iterations (first, steady state, last). After the first iteration, the graph for each iteration should remain the same from iteration to iteration. This allows XLA runtime to execute a previous compiled graph that has been cached in XLA runtime cache.</p> <p>If the inner training loop has some control-flows, for example for gradient accumulation, the number of compiled graphs may increase due to the generation and consumption of intermediates as well as additional operations when the conditional path is taken.</p> </div> <div class="section" id="multi-worker-data-parallel-mlp-training-using-torchrun"> <h2><a class="toc-backref" href="#id5">Multi-worker data-parallel MLP training using torchrun</a><a class="headerlink" href="#multi-worker-data-parallel-mlp-training-using-torchrun" title="Permalink to this headline">#</a></h2> <p>Data parallel training allows you to replicate your script across multiple workers, each worker processing a proportional portion of the dataset, in order to train faster.</p> <p>The PyTorch distributed utility torchrun can be used to launch multiple processes in a server node for multi-worker data parallel training.</p> <p>To run multiple workers in data parallel configuration using torchrun, modify the single-worker training script train.py as follows (below we use <code class="docutils literal notranslate"><span class="pre">xm</span></code> as alias for <code class="docutils literal notranslate"><span class="pre">torch_xla.core.xla_model</span></code> and <code class="docutils literal notranslate"><span class="pre">xmp</span></code> as alias for <code class="docutils literal notranslate"><span class="pre">torch_xla.distributed.xla_multiprocessing</span></code>):</p> <ol class="arabic simple"> <li><p>Import XLA backend for torch.distributed using <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">torch_xla.distributed.xla_backend</span></code>.</p></li> <li><p>Use <code class="docutils literal notranslate"><span class="pre">torch.distributed.init_process_group('xla')</span></code> to initialize PyTorch XLA runtime and Neuron runtime.</p></li> <li><p>Use XLA multiprocessing device loader (<code class="docutils literal notranslate"><span class="pre">MpDeviceLoader</span></code>) from <code class="docutils literal notranslate"><span class="pre">torch_xla.distributed</span></code> to wrap PyTorch data loader.</p></li> <li><p>Use <code class="docutils literal notranslate"><span class="pre">xm.optimizer_step(optimizer)</span></code> to perform allreduce and take optimizer step.</p></li> </ol> <p>XLA MpDeviceLoader is optimized for XLA and is recommended for best performance. It also takes care of marking the step for execution (compile and execute the lazily collected operations for an iteration) so no separate <code class="docutils literal notranslate"><span class="pre">xm.mark_step()</span></code> is needed.</p> <p>The following are general best-practice changes needed to scale up the training:</p> <ol class="arabic simple"> <li><p>Set the random seed to be the same across workers.</p></li> <li><p>Scale up the learning rate by the number of workers. Use <code class="docutils literal notranslate"><span class="pre">xm.xrt_world_size()</span></code> to get the global number of workers.</p></li> <li><p>Add distributed sampler to allow different worker to sample different portions of dataset.</p></li> </ol> <p>Also, the <code class="docutils literal notranslate"><span class="pre">xm.save()</span></code> function used to save checkpoint automatically saves only for the rank-0 worker’s parameters.</p> <p>The resulting script is <code class="docutils literal notranslate"><span class="pre">train_torchrun.py</span></code> (note again that we import the MLP model from <code class="docutils literal notranslate"><span class="pre">model.py</span></code>):</p> <p>Next we use the <code class="docutils literal notranslate"><span class="pre">torchrun</span></code> utility that is included with torch installation to run multiple processes, each using one NeuronCore. Use the option <code class="docutils literal notranslate"><span class="pre">nproc_per_node</span></code> to indicate the number of processes to launch. For example, to run on two NeuronCores on one Trn1 instance only, do:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">2</span><span class="w"> </span>train_torchrun.py </pre></div> </div> <p>NOTE: Currently we only support 1 and 2 worker configurations on trn1.2xlarge and 1, 2, 8, and 32-worker configurations on trn1.32xlarge.</p> <p>Expected output on trn1.32xlarge (second run to avoid compilations):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>----------Training<span class="w"> </span>--------------- ----------Training<span class="w"> </span>--------------- ...<span class="w"> </span><span class="o">(</span>Info<span class="w"> </span>messages<span class="w"> </span>truncated<span class="o">)</span> Train<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">163</span>.25353269069706 Train<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">163</span>.23261047441036 Final<span class="w"> </span>loss<span class="w"> </span>is<span class="w"> </span><span class="m">0</span>.3469 Final<span class="w"> </span>loss<span class="w"> </span>is<span class="w"> </span><span class="m">0</span>.1129 ----------End<span class="w"> </span>Training<span class="w"> </span>--------------- ----------End<span class="w"> </span>Training<span class="w"> </span>--------------- </pre></div> </div> <p>In another example, we run on two trn1.32xlarge instances launched with EFA-enabled interfaces, using <a class="reference external" href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa-start-nccl-base.html#nccl-start-base-setup">EFA-enabled security group</a>, and setup using <a class="reference internal" href="../../setup/pytorch-install.html#pytorch-neuronx-install"><span class="std std-ref">Install PyTorch Neuron on Trn1</span></a>. NOTE: To run on multiple instances, you will need to use trn1.32xlarge instances and using all 32 NeuronCores on each instance.</p> <p>On the rank-0 Trn1 host (root), run with <code class="docutils literal notranslate"><span class="pre">--node_rank=0</span></code> using torchrun utility, and <code class="docutils literal notranslate"><span class="pre">--master_addr</span></code> set to rank-0 host’s IP address:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">FI_EFA_USE_DEVICE_RDMA</span><span class="o">=</span><span class="m">1</span> <span class="nb">export</span><span class="w"> </span><span class="nv">FI_PROVIDER</span><span class="o">=</span>efa torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span>--nnodes<span class="o">=</span><span class="m">2</span><span class="w"> </span>--node_rank<span class="o">=</span><span class="m">0</span><span class="w"> </span>--master_addr<span class="o">=</span>&lt;root<span class="w"> </span>IP&gt;<span class="w"> </span>--master_port<span class="o">=</span><span class="m">2020</span><span class="w"> </span>train_torchrun.py </pre></div> </div> <p>On another Trn1 host, run with <code class="docutils literal notranslate"><span class="pre">--node_rank=1</span></code>, and <code class="docutils literal notranslate"><span class="pre">--master_addr</span></code> also set to rank-0 host’s IP address:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">FI_EFA_USE_DEVICE_RDMA</span><span class="o">=</span><span class="m">1</span> <span class="nb">export</span><span class="w"> </span><span class="nv">FI_PROVIDER</span><span class="o">=</span>efa torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span>--nnodes<span class="o">=</span><span class="m">2</span><span class="w"> </span>--node_rank<span class="o">=</span><span class="m">1</span><span class="w"> </span>--master_addr<span class="o">=</span>&lt;root<span class="w"> </span>IP&gt;<span class="w"> </span>--master_port<span class="o">=</span><span class="m">2020</span><span class="w"> </span>train_torchrun.py </pre></div> </div> <p>It is important to launch rank-0 worker with <code class="docutils literal notranslate"><span class="pre">--node_rank=0</span></code> to avoid hang.</p> <p>To train on multiple instances, it is recommended to use a ParallelCluster. For a ParallelCluster example, please see <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples">Train a model on AWS Trn1 ParallelCluster</a>.</p> </div> <div class="section" id="single-worker-mlp-evaluation-on-trainium"> <h2><a class="toc-backref" href="#id6">Single-worker MLP evaluation on Trainium</a><a class="headerlink" href="#single-worker-mlp-evaluation-on-trainium" title="Permalink to this headline">#</a></h2> <p>After training, the final checkpoint is saved in <code class="docutils literal notranslate"><span class="pre">checkpoints</span></code> directory. You can run the evaluation step by running the <code class="docutils literal notranslate"><span class="pre">eval.py</span></code> script in the same directory as the training script:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/mnist_mlp python<span class="w"> </span>eval.py </pre></div> </div> <p>This evaluation phase can be merged with the training script to check accuracy, for example at the end of every epoch. It is kept separate for illustration purpose.</p> <p>The evaluation script follow similar flow as the training script with the following differences:</p> <ul class="simple"> <li><p>The input data used is the validation subset of the MNIST dataset.</p></li> <li><p>Only need to loop through the dataset once (no epochs).</p></li> <li><p>There’s only forward pass through the model, and no backward pass or optimizer update.</p></li> <li><p>Compute the accuracy across validation set instead of loss per batch.</p></li> </ul> <p>Expected results (after a second execution to eliminate warmup compilation time during first execution):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>----------Evaluating--------------- Test<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">47</span>.897945949832845 Accuracy:<span class="w"> </span><span class="m">0</span>.9273833632469177 ----------Done<span class="w"> </span>Evaluating--------------- </pre></div> </div> <p>If you get a lower accuracy than above, please check that the training is done with at least 4 epochs.</p> <p>You can also use <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html#torch-neuronx-trace-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Tracing API for Inference</span></a> in the evaluation loop. This can be achieved by the following changes to the <code class="docutils literal notranslate"><span class="pre">eval.py</span></code>:</p> <ul class="simple"> <li><p>Use <code class="docutils literal notranslate"><span class="pre">device</span> <span class="pre">=</span> <span class="pre">'cpu'</span></code> instead of XLA device.</p></li> <li><p>Don’t use <code class="docutils literal notranslate"><span class="pre">mark_step()</span></code>.</p></li> <li><p>Trace the model at the first iteration to freeze it and precompile for inference:</p></li> </ul> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="n">idx</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="n">model</span> <span class="o">=</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">test_x</span><span class="p">)</span> </pre></div> </div> <p>However, note that the inference trace API fixed the input tensor shape, so that every input tensor will need to match the size used during the tracing step. To ensure every batch from <code class="docutils literal notranslate"><span class="pre">DataLoader</span></code> has the same tensor shape, pass <code class="docutils literal notranslate"><span class="pre">drop_last=True</span></code> option when instantiating <code class="docutils literal notranslate"><span class="pre">DataLoader</span></code>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">test_loader</span> <span class="o">=</span> <span class="n">DataLoader</span><span class="p">(</span><span class="n">test_dataset</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="mi">32</span><span class="p">,</span> <span class="n">drop_last</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> </pre></div> </div> <p>The script <code class="docutils literal notranslate"><span class="pre">eval_using_trace.py</span></code> can be compared against <code class="docutils literal notranslate"><span class="pre">eval.py</span></code> to show the above modifications. It can be executed using:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>eval_using_trace.py </pre></div> </div> <p>Expected results (note the large increase in performance when using trace API for inference):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>----------Evaluating--------------- Test<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">409</span>.0836291417652 Accuracy:<span class="w"> </span><span class="m">0</span>.9288585186004639 ----------Done<span class="w"> </span>Evaluating--------------- </pre></div> </div> </div> <div class="section" id="known-issues-and-limitations"> <h2><a class="toc-backref" href="#id7">Known issues and limitations</a><a class="headerlink" href="#known-issues-and-limitations" title="Permalink to this headline">#</a></h2> <p>MLP model is not optimized for performance. For the single-worker training, the performance can be improved by using MpDeviceLoader which exists in the multiprocessing example. For example, by setting <code class="docutils literal notranslate"><span class="pre">--nproc_per_node=1</span></code> in the torchrun example, you will see higher MLP performance.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">(</span>aws_neuron_venv_pytorch_p36<span class="o">)</span><span class="w"> </span><span class="o">[</span>ec2-user@ip-172-31-69-14<span class="w"> </span>mnist_mlp<span class="o">]</span>$<span class="w"> </span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">1</span><span class="w"> </span>train_torchrun.py ----------Training<span class="w"> </span>--------------- ...<span class="w"> </span><span class="o">(</span>Info<span class="w"> </span>messages<span class="w"> </span>truncated<span class="o">)</span> Train<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">192</span>.43508922834008 Final<span class="w"> </span>loss<span class="w"> </span>is<span class="w"> </span><span class="m">0</span>.2720 ----------End<span class="w"> </span>Training<span class="w"> </span>--------------- </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="bert.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Hugging Face BERT Pretraining Tutorial</p> </div> </a> <a class="right-next" id="next-link" href="finetune_hftrainer.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:04.357Z
PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html
# PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API — AWS Neuron Documentation ## PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API[#](#pytorch-neuron-for-trainium-hugging-face-bert-mrpc-task-finetuning-using-hugging-face-trainer-api "Permalink to this headline") In this tutorial, we show how to run a Hugging Face script that uses Hugging Face Trainer API to do fine-tuning on Trainium. The example follows the [text-classification example](https://github.com/huggingface/transformers/tree/master/examples/pytorch/text-classification) which fine-tunes BERT-base model for sequence classification on the GLUE benchmark. Table of Contents - [Setup and compilation](#setup-and-compilation) - [Single-worker training](#single-worker-training) - [Multi-worker training](#multi-worker-training) - [Converting BERT pretrained checkpoint to Hugging Face pretrained model format](#converting-bert-pretrained-checkpoint-to-hugging-face-pretrained-model-format) - [Older versions of transformers <4.27.0 or PyTorch Neuron <1.13.0](#older-versions-of-transformers-4-27-0-or-pytorch-neuron-1-13-0) - [Known issues and limitations](#known-issues-and-limitations) Note Logs used in tutorials do not present latest performance numbers For latest performance numbers visit [Neuron Performance](../../../../../general/benchmarks/index.html#benchmark) ## [Setup and compilation](#id2)[#](#setup-and-compilation "Permalink to this headline") Before running the tutorial please follow the installation instructions at: [Install PyTorch Neuron on Trn1](../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx) Please set the storage of instance to _512GB_ or more if you also want to run through the BERT pretraining and GPT pretraining tutorials. For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands: ``` source ~/aws_neuron_venv_pytorch/bin/activate ``` First we install a recent version of HF transformers, scikit-learn and evaluate packages in our environment as well as download the source matching the installed version. In this example, we use the text classification example from HF transformers source: ``` export HF_VER=4.27.4 pip install -U transformers==$HF_VER datasets evaluate scikit-learn cd ~/ git clone https://github.com/huggingface/transformers --branch v$HF_VER cd ~/transformers/examples/pytorch/text-classification ``` ## [Single-worker training](#id3)[#](#single-worker-training "Permalink to this headline") We will run MRPC task fine-tuning following the example in README.md located in the path `~/transformers/examples/pytorch/text-classification`. In this part of the tutorial we will use the Hugging Face model hub’s pretrained `bert-large-uncased` model. Note If you are using older versions of transformers <4.27.0 or PyTorch Neuron <1.13.0, please see section [Older versions of transformers <4.27.0 or PyTorch Neuron <1.13.0](#workarounds-for-older-versions) for necessary workarounds. We use full BF16 casting using XLA\_USE\_BF16=1 and compiler flag `--model-type=transformer` to enable best performance. First, paste the following script into your terminal to create a “run.sh” file and change it to executable: ``` tee run.sh > /dev/null <<EOF #!/usr/bin/env bash export TASK_NAME=mrpc export NEURON_CC_FLAGS="--model-type=transformer" XLA_USE_BF16=1 python3 ./run_glue.py \\ --model_name_or_path bert-large-uncased \\ --task_name \$TASK_NAME \\ --do_train \\ --do_eval \\ --max_seq_length 128 \\ --per_device_train_batch_size 8 \\ --learning_rate 2e-5 \\ --num_train_epochs 5 \\ --overwrite_output_dir \\ --output_dir /tmp/\$TASK_NAME/ |& tee log_run EOF chmod +x run.sh ``` We optionally precompile the model and training script using neuron\_parallel\_compile to warm up the persistent graph cache (Neuron Cache) such that the actual run has fewer compilations (faster run time): ``` neuron_parallel_compile ./run.sh ``` Please ignore the results from this precompile run as it is only for extracting and compiling the XLA graphs. Note With both train and evaluation options (`--do_train` and `--do_eval`), you will encounter harmless error `ValueError: Target is multiclass but average='binary'` when using neuron\_parallel\_compile. Precompilation is optional and only needed to be done once unless hyperparameters such as batch size are modified. After the optional precompilation, the actual run will be faster with minimal additional compilations. If precompilation was not done, the first execution of ./run.sh will be slower due to serial compilations. Rerunning the same script a second time would show quicker execution as the compiled graphs will be already cached in persistent cache. ## [Multi-worker training](#id4)[#](#multi-worker-training "Permalink to this headline") The above script would run one worker on one NeuronCore. To run on multiple cores, launch the `run_glue.py` script with `torchrun` using `--nproc_per_node=N` option to specify the number of workers (N=2 for trn1.2xlarge, and N=2, 8, or 32 for trn1.32xlarge). Note If you are using older versions of transformers <4.27.0 or PyTorch Neuron <1.13.0, please see section [Older versions of transformers <4.27.0 or PyTorch Neuron <1.13.0](#workarounds-for-older-versions) for necessary workarounds. The following example runs 2 workers. Paste the following script into your terminal to create a “run\_2w.sh” file and change it to executable: ``` tee run_2w.sh > /dev/null <<EOF #!/usr/bin/env bash export TASK_NAME=mrpc export NEURON_CC_FLAGS="--model-type=transformer" XLA_USE_BF16=1 torchrun --nproc_per_node=2 ./run_glue.py \\ --model_name_or_path bert-large-uncased \\ --task_name \$TASK_NAME \\ --do_train \\ --do_eval \\ --max_seq_length 128 \\ --per_device_train_batch_size 8 \\ --learning_rate 2e-5 \\ --num_train_epochs 5 \\ --overwrite_output_dir \\ --output_dir /tmp/\$TASK_NAME/ |& tee log_run_2w EOF chmod +x run_2w.sh ``` Again, we optionally precompile the model and training script using neuron\_parallel\_compile to warm up the persistent graph cache (Neuron Cache), ignoring the results from this precompile run as it is only for extracting and compiling the XLA graphs: ``` neuron_parallel_compile ./run_2w.sh ``` Precompilation is optional and only needed to be done once unless hyperparameters such as batch size are modified. After the optional precompilation, the actual run will be faster with minimal additional compilations. During run, you will now notice that the “Total train batch size” is now 16 and the “Total optimization steps” is now half the number for one worker training. ## [Converting BERT pretrained checkpoint to Hugging Face pretrained model format](#id5)[#](#converting-bert-pretrained-checkpoint-to-hugging-face-pretrained-model-format "Permalink to this headline") If you have a pretrained checkpoint (i.e., from the BERT phase 2 pretraining tutorial), you can run the script below (saved as “convert.py”) to convert BERT pretrained saved checkpoint to Hugging Face pretrained model format. An example phase 2 pretrained checkpoint can be downloaded from `s3://neuron-s3/training_checkpoints/pytorch/dp_bert_large_hf_pretrain/ckpt_29688.pt`. Note that here we also use the `bert-large-uncased` model configuration to match the BERT-Large model trained following BERT phase 2 pretraining tutorial. ``` import os import sys import argparse import torch import transformers from transformers import ( BertForPreTraining, ) import torch_xla.core.xla_model as xm from transformers.utils import check_min_version from transformers.utils.versions import require_version if __name__ == '__main__': parser = argparse.ArgumentParser() parser.add_argument('--model_name', type=str, default='bert-large-uncased', help="Path to model identifier from huggingface.co/models") parser.add_argument('--output_saved_model_path', type=str, default='./hf_saved_model', help="Directory to save the HF pretrained model format.") parser.add_argument('--checkpoint_path', type=str, required=True, help="Path to pretrained checkpoint which needs to be converted to a HF pretrained model format") args = parser.parse_args(sys.argv[1:]) model = BertForPreTraining.from_pretrained(args.model_name) check_point = torch.load(args.checkpoint_path, map_location='cpu') model.load_state_dict(check_point['model'], strict=False) model.save_pretrained(args.output_saved_model_path, save_config=True, save_function=xm.save) print("Done converting checkpoint {} to HuggingFace saved model in directory {}.".format(args.checkpoint_path, args.output_saved_model_path)) ``` Run the conversion script as: ``` python convert.py --checkpoint_path ckpt_29688.pt ``` After conversion, the new Hugging Face pretrained model is stored in the output directory specified by the `--output_saved_model_path` option which is `hf_saved_model` by default. You will use this directory in the next step. Paste the following script into your terminal to create a “run\_converted.sh” file and change it to executable: (note that it uses the converted Hugging Face pretrained model in `hf_saved_model` directory): ``` tee run_converted.sh > /dev/null <<EOF #!/usr/bin/env bash export TASK_NAME=mrpc export NEURON_CC_FLAGS="--model-type=transformer" XLA_USE_BF16=1 python3 ./run_glue.py \\ --model_name_or_path hf_saved_model \\ --tokenizer_name bert-large-uncased \\ --task_name \$TASK_NAME \\ --do_train \\ --do_eval \\ --max_seq_length 128 \\ --per_device_train_batch_size 8 \\ --learning_rate 2e-5 \\ --num_train_epochs 5 \\ --overwrite_output_dir \\ --output_dir /tmp/\$TASK_NAME/ |& tee log_run_converted EOF chmod +x run_converted.sh ``` If it is the first time running with `bert-large-uncased` model or if hyperparameters have changed, then the optional one-time precompilation step can save compilation time: ``` neuron_parallel_compile ./run_converted.sh ``` If you have run the single worker training in a previous section, then you can skip the precompilation step and just do: ## [Older versions of transformers <4.27.0 or PyTorch Neuron <1.13.0](#id6)[#](#older-versions-of-transformers-4-27-0-or-pytorch-neuron-1-13-0 "Permalink to this headline") If using older versions of transformers package before 4.27.0 or PyTorch Neuron before 1.13.0, please edit the python script run\_glue.py and add the following lines after the Python imports. They set the compiler flag for transformer model type and enable data parallel training using torchrun: ``` # Enable torchrun import os import torch import torch_xla.distributed.xla_backend from packaging import version from transformers import __version__, Trainer if version.parse(__version__) < version.parse("4.26.0") and os.environ.get("WORLD_SIZE"): torch.distributed.init_process_group('xla') # Disable DDP for torchrun import contextlib if version.parse(__version__) < version.parse("4.20.0"): def _wrap_model(self, model, training=True): model.no_sync = lambda: contextlib.nullcontext() return model else: def _wrap_model(self, model, training=True, dataloader=None): model.no_sync = lambda: contextlib.nullcontext() return model Trainer._wrap_model = _wrap_model # Workaround for NaNs seen with transformers version >= 4.21.0 # https://github.com/aws-neuron/aws-neuron-sdk/issues/593 import transformers if os.environ.get("XLA_USE_BF16") or os.environ.get("XLA_DOWNCAST_BF16"): transformers.modeling_utils.get_parameter_dtype = lambda x: torch.bfloat16 ``` ## [Known issues and limitations](#id7)[#](#known-issues-and-limitations "Permalink to this headline") The following are currently known issues: - Long compilation times: this can be alleviated with `neuron_parallel_compile` tool to extract graphs from a short trial run and compile them in parallel ahead of the actual run, as shown above. - When precompiling using batch size of 16 on trn1.2xlarge, you will see `ERROR ||PARALLEL_COMPILE||: parallel compilation with neuronx-cc exited with error.Received error code: -9`. To workaround this error, please set NEURON\_PARALLEL\_COMPILE\_MAX\_RETRIES=1 in the environment. - With release 2.6 and transformers==4.25.1, using `neuron_parallel_compile` tool to run `run_glue.py` script with both train and evaluation options (`--do_train` and `--do_eval`), you will encounter harmless error `ValueError: Target is multiclass but average='binary'` - Reduced accuracy for RoBerta-Large is seen with Neuron PyTorch 1.12 (release 2.6) in FP32 mode with compiler BF16 autocast. The workaround is to set NEURON\_CC\_FLAGS=”–auto-cast none” or set NEURON\_RT\_STOCHASTIC\_ROUNDING\_EN=1. - When using DDP in PT 1.13, compilation of one graph will fail with “Killed” error message for `bert-large-uncased`. For `bert-base-cased`, the final MRPC evaluation accuracy is 31% which is lower than expected. These issues are being investigated and will be fixed in an upcoming release. For now, DDP is disabled with the workaround shown above in [Multi-worker Training](finetune_t5.html#multi-worker-training). - When using DDP in PT 1.13 with neuron\_parallel\_compile precompilation, you will hit an error `Rank 1 has 393 params, while rank 0 has inconsistent 0 params.`. To workaround this error, add the follow code snippet at the top of `run_glue.py` to skip the problematic shape verification code during precompilation: ``` import os if os.environ.get("NEURON_EXTRACT_GRAPHS_ONLY", None): import torch.distributed as dist _verify_param_shape_across_processes = lambda process_group, tensors, logger=None: True ``` - Variable input sizes: When fine-tune models such as dslim/bert-base-NER using the [token-classification example](https://github.com/huggingface/transformers/tree/main/examples/pytorch/token-classification), you may encounter timeouts (lots of “socket.h:524 CCOM WARN Timeout waiting for RX” messages) and execution hang. This occurs because NER dataset has different sample sizes, which causes many recompilations and compiled graph (NEFF) reloads. Furthermore, different data parallel workers can execute different compiled graph. This multiple-program multiple-data behavior is currently unsupported. To workaround this issue, please pad to maximum length using the Trainer API option `--pad_to_max_length`. - When running HuggingFace GPT fine-tuning with transformers version >= 4.21.0 and using XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1, you might see NaNs in the loss immediately at the first step. This issue occurs due to large negative constants used to implement attention masking ([https://github.com/huggingface/transformers/pull/17306](https://github.com/huggingface/transformers/pull/17306)). To workaround this issue, please use transformers version <= 4.20.0. - When using Trainer API option –bf16, you will see “RuntimeError: No CUDA GPUs are available”. To workaround this error, please add “import torch; torch.cuda.is\_bf16\_supported = lambda: True” to the Python script (i.e. run\_glue.py). (Trainer API option –fp16 is not yet supported). The following are resolved issues: - Using `neuron_parallel_compile` tool to run `run_glue.py` script with both train and evaluation options (`--do_train` and `--do_eval`), you will encounter INVALID\_ARGUMENT error. To avoid this, only enable train for parallel compile (`--do_train`). This will cause compilations during evaluation step. The INVALID\_ARGUMENT error is fixed in release 2.6 together with latest transformers package version 4.25.1. - When running HuggingFace BERT (any size) fine-tuning tutorial or pretraining tutorial with transformers version >= 4.21.0 and < 4.25.1 and using XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1, you will see NaNs in the loss immediately at the first step. More details on the issue can be found at [pytorch/xla#4152](https://github.com/pytorch/xla/issues/4152). The workaround is to use transformers version < 4.21.0 or >= 4.25.1, or add `transformers.modeling_utils.get_parameter_dtype = lambda x: torch.bfloat16` to your Python script (i.e. run\_glue.py). - Some recompilation is seen at the epoch boundary even after `neuron_parallel_compile` is used. This can be fixed by using the same number of epochs both during precompilation and the actual run. - When running multi-worker training, you may see the process getting killed at the time of model saving on trn1.2xlarge. This happens because the transformers `trainer.save_model` api uses `xm.save` for saving models. This api is known to cause high host memory usage in multi-worker setting [see Saving and Loading XLA Tensors in](https://github.com/pytorch/xla/blob/master/API_GUIDE.md) . Coupled with a compilation at the same time results in a host OOM. To avoid this issue, we can: Precompile all the graphs in multi-worker training. This can be done by running the multi-worker training first with `neuron_parallel_compile <script>` followed by the actual training. This would avoid the compilation at model save during actual training. _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Fine-tune T5 model on Trn1" href="finetune_t5.html"> <link rel="prev" title="Multi-Layer Perceptron Training Tutorial" href="mlp.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-training-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-and-compilation"> Setup and compilation </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-training"> Single-worker training </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-worker-training"> Multi-worker training </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#converting-bert-pretrained-checkpoint-to-hugging-face-pretrained-model-format"> Converting BERT pretrained checkpoint to Hugging Face pretrained model format </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#older-versions-of-transformers-4-27-0-or-pytorch-neuron-1-13-0"> Older versions of transformers &lt;4.27.0 or PyTorch Neuron &lt;1.13.0 </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known issues and limitations </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-and-compilation"> Setup and compilation </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-training"> Single-worker training </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-worker-training"> Multi-worker training </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#converting-bert-pretrained-checkpoint-to-hugging-face-pretrained-model-format"> Converting BERT pretrained checkpoint to Hugging Face pretrained model format </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#older-versions-of-transformers-4-27-0-or-pytorch-neuron-1-13-0"> Older versions of transformers &lt;4.27.0 or PyTorch Neuron &lt;1.13.0 </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known issues and limitations </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-for-trainium-hugging-face-bert-mrpc-task-finetuning-using-hugging-face-trainer-api"> <span id="torch-hf-bert-finetune"></span><h1>PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API<a class="headerlink" href="#pytorch-neuron-for-trainium-hugging-face-bert-mrpc-task-finetuning-using-hugging-face-trainer-api" title="Permalink to this headline">#</a></h1> <p>In this tutorial, we show how to run a Hugging Face script that uses Hugging Face Trainer API to do fine-tuning on Trainium. The example follows the <a class="reference external" href="https://github.com/huggingface/transformers/tree/master/examples/pytorch/text-classification">text-classification example</a> which fine-tunes BERT-base model for sequence classification on the GLUE benchmark.</p> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#setup-and-compilation" id="id2">Setup and compilation</a></p></li> <li><p><a class="reference internal" href="#single-worker-training" id="id3">Single-worker training</a></p></li> <li><p><a class="reference internal" href="#multi-worker-training" id="id4">Multi-worker training</a></p></li> <li><p><a class="reference internal" href="#converting-bert-pretrained-checkpoint-to-hugging-face-pretrained-model-format" id="id5">Converting BERT pretrained checkpoint to Hugging Face pretrained model format</a></p></li> <li><p><a class="reference internal" href="#older-versions-of-transformers-4-27-0-or-pytorch-neuron-1-13-0" id="id6">Older versions of transformers &lt;4.27.0 or PyTorch Neuron &lt;1.13.0</a></p></li> <li><p><a class="reference internal" href="#known-issues-and-limitations" id="id7">Known issues and limitations</a></p></li> </ul> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Logs used in tutorials do not present latest performance numbers</p> <p>For latest performance numbers visit <a class="reference internal" href="../../../../../general/benchmarks/index.html#benchmark"><span class="std std-ref">Neuron Performance</span></a></p> </div> <div class="section" id="setup-and-compilation"> <h2><a class="toc-backref" href="#id2">Setup and compilation</a><a class="headerlink" href="#setup-and-compilation" title="Permalink to this headline">#</a></h2> <p>Before running the tutorial please follow the installation instructions at:</p> <p><a class="reference internal" href="../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx"><span class="std std-ref">Install PyTorch Neuron on Trn1</span></a></p> <p>Please set the storage of instance to <em>512GB</em> or more if you also want to run through the BERT pretraining and GPT pretraining tutorials.</p> <p>For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>~/aws_neuron_venv_pytorch/bin/activate </pre></div> </div> <p>First we install a recent version of HF transformers, scikit-learn and evaluate packages in our environment as well as download the source matching the installed version. In this example, we use the text classification example from HF transformers source:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">HF_VER</span><span class="o">=</span><span class="m">4</span>.27.4 pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span><span class="nv">transformers</span><span class="o">==</span><span class="nv">$HF_VER</span><span class="w"> </span>datasets<span class="w"> </span>evaluate<span class="w"> </span>scikit-learn <span class="nb">cd</span><span class="w"> </span>~/ git<span class="w"> </span>clone<span class="w"> </span>https://github.com/huggingface/transformers<span class="w"> </span>--branch<span class="w"> </span>v<span class="nv">$HF_VER</span> <span class="nb">cd</span><span class="w"> </span>~/transformers/examples/pytorch/text-classification </pre></div> </div> </div> <div class="section" id="single-worker-training"> <h2><a class="toc-backref" href="#id3">Single-worker training</a><a class="headerlink" href="#single-worker-training" title="Permalink to this headline">#</a></h2> <p>We will run MRPC task fine-tuning following the example in README.md located in the path <code class="docutils literal notranslate"><span class="pre">~/transformers/examples/pytorch/text-classification</span></code>. In this part of the tutorial we will use the Hugging Face model hub’s pretrained <code class="docutils literal notranslate"><span class="pre">bert-large-uncased</span></code> model.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>If you are using older versions of transformers &lt;4.27.0 or PyTorch Neuron &lt;1.13.0, please see section <a class="reference internal" href="#workarounds-for-older-versions"><span class="std std-ref">Older versions of transformers &lt;4.27.0 or PyTorch Neuron &lt;1.13.0</span></a> for necessary workarounds.</p> </div> <p>We use full BF16 casting using XLA_USE_BF16=1 and compiler flag <code class="docutils literal notranslate"><span class="pre">--model-type=transformer</span></code> to enable best performance. First, paste the following script into your terminal to create a “run.sh” file and change it to executable:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tee<span class="w"> </span>run.sh<span class="w"> </span>&gt;<span class="w"> </span>/dev/null<span class="w"> </span><span class="s">&lt;&lt;EOF</span> <span class="s">#!/usr/bin/env bash</span> <span class="s">export TASK_NAME=mrpc</span> <span class="s">export NEURON_CC_FLAGS="--model-type=transformer"</span> <span class="s">XLA_USE_BF16=1 python3 ./run_glue.py \\</span> <span class="s">--model_name_or_path bert-large-uncased \\</span> <span class="s">--task_name \$TASK_NAME \\</span> <span class="s">--do_train \\</span> <span class="s">--do_eval \\</span> <span class="s">--max_seq_length 128 \\</span> <span class="s">--per_device_train_batch_size 8 \\</span> <span class="s">--learning_rate 2e-5 \\</span> <span class="s">--num_train_epochs 5 \\</span> <span class="s">--overwrite_output_dir \\</span> <span class="s">--output_dir /tmp/\$TASK_NAME/ |&amp; tee log_run</span> <span class="s">EOF</span> chmod<span class="w"> </span>+x<span class="w"> </span>run.sh </pre></div> </div> <p>We optionally precompile the model and training script using neuron_parallel_compile to warm up the persistent graph cache (Neuron Cache) such that the actual run has fewer compilations (faster run time):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>neuron_parallel_compile<span class="w"> </span>./run.sh </pre></div> </div> <p>Please ignore the results from this precompile run as it is only for extracting and compiling the XLA graphs.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>With both train and evaluation options (<code class="docutils literal notranslate"><span class="pre">--do_train</span></code> and <code class="docutils literal notranslate"><span class="pre">--do_eval</span></code>), you will encounter harmless error <code class="docutils literal notranslate"><span class="pre">ValueError:</span> <span class="pre">Target</span> <span class="pre">is</span> <span class="pre">multiclass</span> <span class="pre">but</span> <span class="pre">average='binary'</span></code> when using neuron_parallel_compile.</p> </div> <p>Precompilation is optional and only needed to be done once unless hyperparameters such as batch size are modified. After the optional precompilation, the actual run will be faster with minimal additional compilations.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./run.sh </pre></div> </div> <p>If precompilation was not done, the first execution of ./run.sh will be slower due to serial compilations. Rerunning the same script a second time would show quicker execution as the compiled graphs will be already cached in persistent cache.</p> </div> <div class="section" id="multi-worker-training"> <span id="id1"></span><h2><a class="toc-backref" href="#id4">Multi-worker training</a><a class="headerlink" href="#multi-worker-training" title="Permalink to this headline">#</a></h2> <p>The above script would run one worker on one NeuronCore. To run on multiple cores, launch the <code class="docutils literal notranslate"><span class="pre">run_glue.py</span></code> script with <code class="docutils literal notranslate"><span class="pre">torchrun</span></code> using <code class="docutils literal notranslate"><span class="pre">--nproc_per_node=N</span></code> option to specify the number of workers (N=2 for trn1.2xlarge, and N=2, 8, or 32 for trn1.32xlarge).</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>If you are using older versions of transformers &lt;4.27.0 or PyTorch Neuron &lt;1.13.0, please see section <a class="reference internal" href="#workarounds-for-older-versions"><span class="std std-ref">Older versions of transformers &lt;4.27.0 or PyTorch Neuron &lt;1.13.0</span></a> for necessary workarounds.</p> </div> <p>The following example runs 2 workers. Paste the following script into your terminal to create a “run_2w.sh” file and change it to executable:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tee<span class="w"> </span>run_2w.sh<span class="w"> </span>&gt;<span class="w"> </span>/dev/null<span class="w"> </span><span class="s">&lt;&lt;EOF</span> <span class="s">#!/usr/bin/env bash</span> <span class="s">export TASK_NAME=mrpc</span> <span class="s">export NEURON_CC_FLAGS="--model-type=transformer"</span> <span class="s">XLA_USE_BF16=1 torchrun --nproc_per_node=2 ./run_glue.py \\</span> <span class="s">--model_name_or_path bert-large-uncased \\</span> <span class="s">--task_name \$TASK_NAME \\</span> <span class="s">--do_train \\</span> <span class="s">--do_eval \\</span> <span class="s">--max_seq_length 128 \\</span> <span class="s">--per_device_train_batch_size 8 \\</span> <span class="s">--learning_rate 2e-5 \\</span> <span class="s">--num_train_epochs 5 \\</span> <span class="s">--overwrite_output_dir \\</span> <span class="s">--output_dir /tmp/\$TASK_NAME/ |&amp; tee log_run_2w</span> <span class="s">EOF</span> chmod<span class="w"> </span>+x<span class="w"> </span>run_2w.sh </pre></div> </div> <p>Again, we optionally precompile the model and training script using neuron_parallel_compile to warm up the persistent graph cache (Neuron Cache), ignoring the results from this precompile run as it is only for extracting and compiling the XLA graphs:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>neuron_parallel_compile<span class="w"> </span>./run_2w.sh </pre></div> </div> <p>Precompilation is optional and only needed to be done once unless hyperparameters such as batch size are modified. After the optional precompilation, the actual run will be faster with minimal additional compilations.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./run_2w.sh </pre></div> </div> <p>During run, you will now notice that the “Total train batch size” is now 16 and the “Total optimization steps” is now half the number for one worker training.</p> </div> <div class="section" id="converting-bert-pretrained-checkpoint-to-hugging-face-pretrained-model-format"> <h2><a class="toc-backref" href="#id5">Converting BERT pretrained checkpoint to Hugging Face pretrained model format</a><a class="headerlink" href="#converting-bert-pretrained-checkpoint-to-hugging-face-pretrained-model-format" title="Permalink to this headline">#</a></h2> <p>If you have a pretrained checkpoint (i.e., from the BERT phase 2 pretraining tutorial), you can run the script below (saved as “convert.py”) to convert BERT pretrained saved checkpoint to Hugging Face pretrained model format. An example phase 2 pretrained checkpoint can be downloaded from <code class="docutils literal notranslate"><span class="pre">s3://neuron-s3/training_checkpoints/pytorch/dp_bert_large_hf_pretrain/ckpt_29688.pt</span></code>. Note that here we also use the <code class="docutils literal notranslate"><span class="pre">bert-large-uncased</span></code> model configuration to match the BERT-Large model trained following BERT phase 2 pretraining tutorial.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span> <span class="kn">import</span> <span class="nn">sys</span> <span class="kn">import</span> <span class="nn">argparse</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">transformers</span> <span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="p">(</span> <span class="n">BertForPreTraining</span><span class="p">,</span> <span class="p">)</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="kn">from</span> <span class="nn">transformers.utils</span> <span class="kn">import</span> <span class="n">check_min_version</span> <span class="kn">from</span> <span class="nn">transformers.utils.versions</span> <span class="kn">import</span> <span class="n">require_version</span> <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span> <span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">()</span> <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--model_name'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">'bert-large-uncased'</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Path to model identifier from huggingface.co/models"</span><span class="p">)</span> <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--output_saved_model_path'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">'./hf_saved_model'</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Directory to save the HF pretrained model format."</span><span class="p">)</span> <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--checkpoint_path'</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Path to pretrained checkpoint which needs to be converted to a HF pretrained model format"</span><span class="p">)</span> <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span> <span class="n">model</span> <span class="o">=</span> <span class="n">BertForPreTraining</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">model_name</span><span class="p">)</span> <span class="n">check_point</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">checkpoint_path</span><span class="p">,</span> <span class="n">map_location</span><span class="o">=</span><span class="s1">'cpu'</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">load_state_dict</span><span class="p">(</span><span class="n">check_point</span><span class="p">[</span><span class="s1">'model'</span><span class="p">],</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">save_pretrained</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">output_saved_model_path</span><span class="p">,</span> <span class="n">save_config</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">save_function</span><span class="o">=</span><span class="n">xm</span><span class="o">.</span><span class="n">save</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Done converting checkpoint </span><span class="si">{}</span><span class="s2"> to HuggingFace saved model in directory </span><span class="si">{}</span><span class="s2">."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">checkpoint_path</span><span class="p">,</span> <span class="n">args</span><span class="o">.</span><span class="n">output_saved_model_path</span><span class="p">))</span> </pre></div> </div> <p>Run the conversion script as:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>convert.py<span class="w"> </span>--checkpoint_path<span class="w"> </span>ckpt_29688.pt </pre></div> </div> <p>After conversion, the new Hugging Face pretrained model is stored in the output directory specified by the <code class="docutils literal notranslate"><span class="pre">--output_saved_model_path</span></code> option which is <code class="docutils literal notranslate"><span class="pre">hf_saved_model</span></code> by default. You will use this directory in the next step.</p> <p>Paste the following script into your terminal to create a “run_converted.sh” file and change it to executable: (note that it uses the converted Hugging Face pretrained model in <code class="docutils literal notranslate"><span class="pre">hf_saved_model</span></code> directory):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tee<span class="w"> </span>run_converted.sh<span class="w"> </span>&gt;<span class="w"> </span>/dev/null<span class="w"> </span><span class="s">&lt;&lt;EOF</span> <span class="s">#!/usr/bin/env bash</span> <span class="s">export TASK_NAME=mrpc</span> <span class="s">export NEURON_CC_FLAGS="--model-type=transformer"</span> <span class="s">XLA_USE_BF16=1 python3 ./run_glue.py \\</span> <span class="s">--model_name_or_path hf_saved_model \\</span> <span class="s">--tokenizer_name bert-large-uncased \\</span> <span class="s">--task_name \$TASK_NAME \\</span> <span class="s">--do_train \\</span> <span class="s">--do_eval \\</span> <span class="s">--max_seq_length 128 \\</span> <span class="s">--per_device_train_batch_size 8 \\</span> <span class="s">--learning_rate 2e-5 \\</span> <span class="s">--num_train_epochs 5 \\</span> <span class="s">--overwrite_output_dir \\</span> <span class="s">--output_dir /tmp/\$TASK_NAME/ |&amp; tee log_run_converted</span> <span class="s">EOF</span> chmod<span class="w"> </span>+x<span class="w"> </span>run_converted.sh </pre></div> </div> <p>If it is the first time running with <code class="docutils literal notranslate"><span class="pre">bert-large-uncased</span></code> model or if hyperparameters have changed, then the optional one-time precompilation step can save compilation time:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>neuron_parallel_compile<span class="w"> </span>./run_converted.sh </pre></div> </div> <p>If you have run the single worker training in a previous section, then you can skip the precompilation step and just do:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./run_converted.sh </pre></div> </div> </div> <div class="section" id="older-versions-of-transformers-4-27-0-or-pytorch-neuron-1-13-0"> <span id="workarounds-for-older-versions"></span><h2><a class="toc-backref" href="#id6">Older versions of transformers &lt;4.27.0 or PyTorch Neuron &lt;1.13.0</a><a class="headerlink" href="#older-versions-of-transformers-4-27-0-or-pytorch-neuron-1-13-0" title="Permalink to this headline">#</a></h2> <p>If using older versions of transformers package before 4.27.0 or PyTorch Neuron before 1.13.0, please edit the python script run_glue.py and add the following lines after the Python imports. They set the compiler flag for transformer model type and enable data parallel training using torchrun:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Enable torchrun</span> <span class="kn">import</span> <span class="nn">os</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_xla.distributed.xla_backend</span> <span class="kn">from</span> <span class="nn">packaging</span> <span class="kn">import</span> <span class="n">version</span> <span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">__version__</span><span class="p">,</span> <span class="n">Trainer</span> <span class="k">if</span> <span class="n">version</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">__version__</span><span class="p">)</span> <span class="o">&lt;</span> <span class="n">version</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s2">"4.26.0"</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"WORLD_SIZE"</span><span class="p">):</span> <span class="n">torch</span><span class="o">.</span><span class="n">distributed</span><span class="o">.</span><span class="n">init_process_group</span><span class="p">(</span><span class="s1">'xla'</span><span class="p">)</span> <span class="c1"># Disable DDP for torchrun</span> <span class="kn">import</span> <span class="nn">contextlib</span> <span class="k">if</span> <span class="n">version</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">__version__</span><span class="p">)</span> <span class="o">&lt;</span> <span class="n">version</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s2">"4.20.0"</span><span class="p">):</span> <span class="k">def</span> <span class="nf">_wrap_model</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">training</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> <span class="n">model</span><span class="o">.</span><span class="n">no_sync</span> <span class="o">=</span> <span class="k">lambda</span><span class="p">:</span> <span class="n">contextlib</span><span class="o">.</span><span class="n">nullcontext</span><span class="p">()</span> <span class="k">return</span> <span class="n">model</span> <span class="k">else</span><span class="p">:</span> <span class="k">def</span> <span class="nf">_wrap_model</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">training</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">dataloader</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="n">model</span><span class="o">.</span><span class="n">no_sync</span> <span class="o">=</span> <span class="k">lambda</span><span class="p">:</span> <span class="n">contextlib</span><span class="o">.</span><span class="n">nullcontext</span><span class="p">()</span> <span class="k">return</span> <span class="n">model</span> <span class="n">Trainer</span><span class="o">.</span><span class="n">_wrap_model</span> <span class="o">=</span> <span class="n">_wrap_model</span> <span class="c1"># Workaround for NaNs seen with transformers version &gt;= 4.21.0</span> <span class="c1"># https://github.com/aws-neuron/aws-neuron-sdk/issues/593</span> <span class="kn">import</span> <span class="nn">transformers</span> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"XLA_USE_BF16"</span><span class="p">)</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"XLA_DOWNCAST_BF16"</span><span class="p">):</span> <span class="n">transformers</span><span class="o">.</span><span class="n">modeling_utils</span><span class="o">.</span><span class="n">get_parameter_dtype</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">bfloat16</span> </pre></div> </div> </div> <div class="section" id="known-issues-and-limitations"> <span id="known-issues"></span><h2><a class="toc-backref" href="#id7">Known issues and limitations</a><a class="headerlink" href="#known-issues-and-limitations" title="Permalink to this headline">#</a></h2> <p>The following are currently known issues:</p> <ul class="simple"> <li><p>Long compilation times: this can be alleviated with <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> tool to extract graphs from a short trial run and compile them in parallel ahead of the actual run, as shown above.</p></li> <li><p>When precompiling using batch size of 16 on trn1.2xlarge, you will see <code class="docutils literal notranslate"><span class="pre">ERROR</span> <span class="pre">||PARALLEL_COMPILE||:</span> <span class="pre">parallel</span> <span class="pre">compilation</span> <span class="pre">with</span> <span class="pre">neuronx-cc</span> <span class="pre">exited</span> <span class="pre">with</span> <span class="pre">error.Received</span> <span class="pre">error</span> <span class="pre">code:</span> <span class="pre">-9</span></code>. To workaround this error, please set NEURON_PARALLEL_COMPILE_MAX_RETRIES=1 in the environment.</p></li> <li><p>With release 2.6 and transformers==4.25.1, using <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> tool to run <code class="docutils literal notranslate"><span class="pre">run_glue.py</span></code> script with both train and evaluation options (<code class="docutils literal notranslate"><span class="pre">--do_train</span></code> and <code class="docutils literal notranslate"><span class="pre">--do_eval</span></code>), you will encounter harmless error <code class="docutils literal notranslate"><span class="pre">ValueError:</span> <span class="pre">Target</span> <span class="pre">is</span> <span class="pre">multiclass</span> <span class="pre">but</span> <span class="pre">average='binary'</span></code></p></li> <li><p>Reduced accuracy for RoBerta-Large is seen with Neuron PyTorch 1.12 (release 2.6) in FP32 mode with compiler BF16 autocast. The workaround is to set NEURON_CC_FLAGS=”–auto-cast none” or set NEURON_RT_STOCHASTIC_ROUNDING_EN=1.</p></li> <li><p>When using DDP in PT 1.13, compilation of one graph will fail with “Killed” error message for <code class="docutils literal notranslate"><span class="pre">bert-large-uncased</span></code>. For <code class="docutils literal notranslate"><span class="pre">bert-base-cased</span></code>, the final MRPC evaluation accuracy is 31% which is lower than expected. These issues are being investigated and will be fixed in an upcoming release. For now, DDP is disabled with the workaround shown above in <a class="reference internal" href="finetune_t5.html#multi-worker-training"><span class="std std-ref">Multi-worker Training</span></a>.</p></li> <li><p>When using DDP in PT 1.13 with neuron_parallel_compile precompilation, you will hit an error <code class="docutils literal notranslate"><span class="pre">Rank</span> <span class="pre">1</span> <span class="pre">has</span> <span class="pre">393</span> <span class="pre">params,</span> <span class="pre">while</span> <span class="pre">rank</span> <span class="pre">0</span> <span class="pre">has</span> <span class="pre">inconsistent</span> <span class="pre">0</span> <span class="pre">params.</span></code>. To workaround this error, add the follow code snippet at the top of <code class="docutils literal notranslate"><span class="pre">run_glue.py</span></code> to skip the problematic shape verification code during precompilation:</p></li> </ul> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"NEURON_EXTRACT_GRAPHS_ONLY"</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span> <span class="kn">import</span> <span class="nn">torch.distributed</span> <span class="k">as</span> <span class="nn">dist</span> <span class="n">_verify_param_shape_across_processes</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">process_group</span><span class="p">,</span> <span class="n">tensors</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="kc">None</span><span class="p">:</span> <span class="kc">True</span> </pre></div> </div> <ul class="simple"> <li><p>Variable input sizes: When fine-tune models such as dslim/bert-base-NER using the <a class="reference external" href="https://github.com/huggingface/transformers/tree/main/examples/pytorch/token-classification">token-classification example</a>, you may encounter timeouts (lots of “socket.h:524 CCOM WARN Timeout waiting for RX” messages) and execution hang. This occurs because NER dataset has different sample sizes, which causes many recompilations and compiled graph (NEFF) reloads. Furthermore, different data parallel workers can execute different compiled graph. This multiple-program multiple-data behavior is currently unsupported. To workaround this issue, please pad to maximum length using the Trainer API option <code class="docutils literal notranslate"><span class="pre">--pad_to_max_length</span></code>.</p></li> <li><p>When running HuggingFace GPT fine-tuning with transformers version &gt;= 4.21.0 and using XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1, you might see NaNs in the loss immediately at the first step. This issue occurs due to large negative constants used to implement attention masking (<a class="reference external" href="https://github.com/huggingface/transformers/pull/17306">https://github.com/huggingface/transformers/pull/17306</a>). To workaround this issue, please use transformers version &lt;= 4.20.0.</p></li> <li><p>When using Trainer API option –bf16, you will see “RuntimeError: No CUDA GPUs are available”. To workaround this error, please add “import torch; torch.cuda.is_bf16_supported = lambda: True” to the Python script (i.e. run_glue.py). (Trainer API option –fp16 is not yet supported).</p></li> </ul> <p>The following are resolved issues:</p> <ul class="simple"> <li><p>Using <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> tool to run <code class="docutils literal notranslate"><span class="pre">run_glue.py</span></code> script with both train and evaluation options (<code class="docutils literal notranslate"><span class="pre">--do_train</span></code> and <code class="docutils literal notranslate"><span class="pre">--do_eval</span></code>), you will encounter INVALID_ARGUMENT error. To avoid this, only enable train for parallel compile (<code class="docutils literal notranslate"><span class="pre">--do_train</span></code>). This will cause compilations during evaluation step. The INVALID_ARGUMENT error is fixed in release 2.6 together with latest transformers package version 4.25.1.</p></li> <li><p>When running HuggingFace BERT (any size) fine-tuning tutorial or pretraining tutorial with transformers version &gt;= 4.21.0 and &lt; 4.25.1 and using XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1, you will see NaNs in the loss immediately at the first step. More details on the issue can be found at <a class="reference external" href="https://github.com/pytorch/xla/issues/4152">pytorch/xla#4152</a>. The workaround is to use transformers version &lt; 4.21.0 or &gt;= 4.25.1, or add <code class="docutils literal notranslate"><span class="pre">transformers.modeling_utils.get_parameter_dtype</span> <span class="pre">=</span> <span class="pre">lambda</span> <span class="pre">x:</span> <span class="pre">torch.bfloat16</span></code> to your Python script (i.e. run_glue.py).</p></li> <li><p>Some recompilation is seen at the epoch boundary even after <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> is used. This can be fixed by using the same number of epochs both during precompilation and the actual run.</p></li> <li><p>When running multi-worker training, you may see the process getting killed at the time of model saving on trn1.2xlarge. This happens because the transformers <code class="docutils literal notranslate"><span class="pre">trainer.save_model</span></code> api uses <code class="docutils literal notranslate"><span class="pre">xm.save</span></code> for saving models. This api is known to cause high host memory usage in multi-worker setting <a class="reference external" href="https://github.com/pytorch/xla/blob/master/API_GUIDE.md">see Saving and Loading XLA Tensors in</a> . Coupled with a compilation at the same time results in a host OOM. To avoid this issue, we can: Precompile all the graphs in multi-worker training. This can be done by running the multi-worker training first with <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span> <span class="pre">&lt;script&gt;</span></code> followed by the actual training. This would avoid the compilation at model save during actual training.</p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="mlp.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Multi-Layer Perceptron Training Tutorial</p> </div> </a> <a class="right-next" id="next-link" href="finetune_t5.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Fine-tune T5 model on Trn1</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:04.772Z
Hugging Face BERT Pretraining Tutorial — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/bert.html
# Hugging Face BERT Pretraining Tutorial — AWS Neuron Documentation ## Hugging Face BERT Pretraining Tutorial[#](#hugging-face-bert-pretraining-tutorial "Permalink to this headline") This tutorial explains how to run Hugging Face BERT-Large model pretraining on Trainium using PyTorch Neuron. The Hugging Face BERT pretraining example demonstrates the steps required to perform single-node, multi-accelerator PyTorch model training using the new AWS EC2 Trn1 (Trainium) instances and the AWS Neuron SDK. This tutorial is an adaptation of an existing [BERT example](https://github.com/NVIDIA/DeepLearningExamples/blob/master/PyTorch/LanguageModeling/BERT/run_pretraining.py) with the following important characteristics: - Framework: PyTorch/XLA - Model: Hugging Face BertForPreTraining - Optimizer: AdamW, LAMB (Layerwise Adaptive Moments optimizer) - Scheduler: Hugging Face’s get\_linear\_schedule\_with\_warmup - Allreduce occurs before optimizer step, after gradient accumulations (following DeepSpeed’s Smart Gradient Accumulation) - Training data types: Float32, full BFloat16 casting and Stochastic Rounding (SR), PyTorch Autocast (Automatic Mixed Precision or AMP) and SR As done in the original BERT paper, BERT pretraining happens in two phases. In the first phase (phase 1) BERT maximum sequence length is fixed at 128 tokens, while in phase 2 it is fixed at 512 tokens. Neuron provides access to Trainium devices through an extension of PyTorch/XLA - a library that includes the familiar PyTorch interface along with XLA-specific additions. For additional details relating to PyTorch/XLA, please refer to the [official PyTorch/XLA documentation](https://pytorch.org/xla/). Table of Contents - [Phase 1 BERT-Large pretraining](#phase-1-bert-large-pretraining) - [Setting up the training environment on trn1.32xlarge](#setting-up-the-training-environment-on-trn1-32xlarge) - [Downloading tokenized and sharded dataset files](#downloading-tokenized-and-sharded-dataset-files) - [Number of workers](#number-of-workers) - [BFloat16 and stochastic rounding in phase 1](#bfloat16-and-stochastic-rounding-in-phase-1) - [Pre-compilation](#pre-compilation) - [Initiating a Training Job](#initiating-a-training-job) - [Monitoring Progress of the Training Job](#monitoring-progress-of-the-training-job) - [Monitoring Training Job Progress using neuron-top](#monitoring-training-job-progress-using-neuron-top) - [Monitoring Training Job Progress using TensorBoard](#monitoring-training-job-progress-using-tensorboard) - [Finishing the tutorial](#finishing-the-tutorial) - [Phase 1 BERT-Large pretraining with Layerwise Adaptive Moments based optimizer (LAMB)](#phase-1-bert-large-pretraining-with-layerwise-adaptive-moments-based-optimizer-lamb) - [Phase 1 BERT-Large pretraining with PyTorch Autocast (AMP) and stochastic rounding](#phase-1-bert-large-pretraining-with-pytorch-autocast-amp-and-stochastic-rounding) - [Phase 1 BERT-Large pretraining on two instances](#phase-1-bert-large-pretraining-on-two-instances) - [Phase 2 BERT-Large pretraining](#phase-2-bert-large-pretraining) - [Training Environment](#training-environment) - [Initiating a Training Job](#id1) - [Tools](#tools) - [neuron-ls](#neuron-ls) - [neuron-top](#neuron-top) - [Generating tokenized and sharded dataset files](#generating-tokenized-and-sharded-dataset-files) - [Known issues and limitations](#known-issues-and-limitations) - [NaNs seen with transformers version >= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1](#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1) - [BERT-large compilation limitations](#bert-large-compilation-limitations) - [BERT-large pretraining with pretokenized dataset hangs when using xm.save](#bert-large-pretraining-with-pretokenized-dataset-hangs-when-using-xm-save) - [BERT-large two worker pretraining hangs or run out of host memory during checkpointing on trn1.2xlarge](#bert-large-two-worker-pretraining-hangs-or-run-out-of-host-memory-during-checkpointing-on-trn1-2xlarge) - [BERT precompilation using neuron\_parallel\_compile hangs when using torchrun](#bert-precompilation-using-neuron-parallel-compile-hangs-when-using-torchrun) - [Reduced multi-node performance with Neuron PyTorch 1.12 (release 2.6)](#reduced-multi-node-performance-with-neuron-pytorch-1-12-release-2-6) - [Troubleshooting](#troubleshooting) - [ModuleNotFoundError: No module named ‘torch’ , ‘torch\_xla’, ‘transformers’, etc](#modulenotfounderror-no-module-named-torch-torch-xla-transformers-etc) Note Logs used in tutorials do not present latest performance numbers For latest performance numbers visit [Neuron Performance](../../../../../general/benchmarks/index.html#benchmark) ## [Phase 1 BERT-Large pretraining](#id3)[#](#phase-1-bert-large-pretraining "Permalink to this headline") ### [Setting up the training environment on trn1.32xlarge](#id4)[#](#setting-up-the-training-environment-on-trn1-32xlarge "Permalink to this headline") The BERT training script `dp_bert_large_hf_pretrain_hdf5.py` can run on a Trainium instance (trn1.32xlarge) that contains the appropriate Neuron runtime and Python dependencies. First, on a trn1.32xlarge instance, follow the installation instructions at: [Install PyTorch Neuron on Trn1](../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx) Please set the storage of instance to _512GB_ or more if you intent to run multiple experiments and save many checkpoints. For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands: ``` source ~/aws_neuron_venv_pytorch/bin/activate ``` Next, clone the AWS Neuron Samples repository and install requirements in the BERT tutorial directory `aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain`: ``` cd ~/ git clone https://github.com/aws-neuron/aws-neuron-samples.git python3 -m pip install -r ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain/requirements.txt ``` ### [Downloading tokenized and sharded dataset files](#id5)[#](#downloading-tokenized-and-sharded-dataset-files "Permalink to this headline") To download the tokenized and sharded dataset files needed for this tutorial, please run the following commands: ``` mkdir -p ~/examples_datasets/ pushd ~/examples_datasets/ aws s3 cp s3://neuron-s3/training_datasets/bert_pretrain_wikicorpus_tokenized_hdf5/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128.tar . --no-sign-request tar -xf bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128.tar rm bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128.tar aws s3 cp s3://neuron-s3/training_datasets/bert_pretrain_wikicorpus_tokenized_hdf5/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512.tar . --no-sign-request tar -xf bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512.tar rm bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512.tar popd ``` `~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128` will now have the tokenized and sharded dataset files for phase 1 pretraining and `~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512` for phase 2 pretraining. ### [Number of workers](#id6)[#](#number-of-workers "Permalink to this headline") You will be using torchrun ([PyTorch’s Elastic Launch](https://pytorch.org/docs/stable/elastic/run.html)) to run some of the commands in this tutorial. When running the training script, you can configure the number of NeuronCores to use for training by using torchrun’s `--nproc_per_node` option. In this tutorial, we use 32 NeuronCores on trn1.32xlarge. Note Currently Neuron Runtime only support 1 and 2 worker configurations on trn1.2xlarge and 1, 2, 8, and 32-worker configurations on trn1.32xlarge. ### [BFloat16 and stochastic rounding in phase 1](#id7)[#](#bfloat16-and-stochastic-rounding-in-phase-1 "Permalink to this headline") Phase 1 pretraining performance can be increased by using BFloat16 casting and stochastic rounding. BFloat16 casting and stochastic rounding can be enabled by setting environment variable `XLA_USE_BF16=1` when launching the pretraining job. `XLA_DOWNCAST_BF16=1` can also be used instead of `XLA_USE_BF16=1` to preserve part of the training loop in FP32. Here we use `XLA_DOWNCAST_BF16=1` to ensure smooth loss curve when loss averaging is used. We also preserve the optimizer states in FP32 using a modified HuggingFace AdamW implementation in order to match FP32 loss with BFloat16. To achieve maximum performance while maintaining loss convergence characteristics, we are using batch size of 16 and gradient accumulation microsteps of 32 to maintain global batch size of 16384 for phase 1. The batch size and gradient accumulation microstep changes can be set by launching the BERT pretraining script `dp_bert_large_hf_pretrain_hdf5.py` with command-line arguments `--batch_size=16 --grad_accum_usteps=32`, as seen in the following steps. Another option with BFloat16 using PyTorch AutoCast (Automatic Mixed Precision or AMP) is covered at [Phase 1 BERT-Large pretraining with PyTorch Autocast (AMP) and stochastic rounding](#amp-sr-phase1). ### [Pre-compilation](#id8)[#](#pre-compilation "Permalink to this headline") PyTorch Neuron evaluates operations lazily during execution of the training loops, which means it builds a symbolic graph in the background and the graph is executed in hardware only when the tensor is printed, transfered to CPU, or `xm.mark_step()` is encountered (`xm.mark_step()` is implicitly called by `pl.MpDeviceLoader/pl.ParallelLoader`). During execution of the training loops, PyTorch Neuron can build multiple graphs depending on the number of conditional paths taken. For BERT-Large pretraining, PyTorch Neuron builds multiple unique graphs that should be compiled before running on the NeuronCores. PyTorch Neuron will compile those graphs only if they are not in the XLA in-memory cache or the persistent cache. To reduce the compilation time of these graphs, you can pre-compile those graphs using the utility `neuron_parallel_compile` (provided by the `libneuronxla` package, a transitive dependency of `torch-neuronx`) as shown: ``` cd ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain neuron_parallel_compile XLA_DOWNCAST_BF16=1 torchrun --nproc_per_node=32 \ dp_bert_large_hf_pretrain_hdf5.py \ --steps_this_run 10 \ --batch_size 16 \ --grad_accum_usteps 32 |& tee compile_log.txt ``` This command performs a fast trial run of the training script to build graphs and then do parallel compilations on those graphs using multiple processes of Neuron Compiler before populating the on-disk persistent cache with compiled graphs. This helps make the actual training run faster because the compiled graphs will loaded from the persistent cache. Currently it takes ~13 minutes to compile the BERT-Large model training step using the pre-compilation script (compare to ~40 minute if not using the pre-compilation script). Note that the command above specifies 32 NeuronCores for trn1.32xlarge via –nproc\_per\_node option. The script `run_dp_bert_large_hf_pretrain_bf16_s128.sh` is provided in the same BERT tutorial directory for convenience and you can simply run the script using `neuron_parallel_compile ./run_dp_bert_large_hf_pretrain_bf16_s128.sh` to start the precompilation. The pretokenized dataset is expected to be at `~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128/` by default (see above for downloading instructions) and can be changed via the `--data_dir` option. Note The trial run during pre-compilation currently outputs invalid loss numbers. Please disregard them. Note The command after `neuron_parallel_compile` should match the actual run command, except for the option `--steps_this_run` which shortens the trial run just enough to allow the tool to build all the graphs needed for the actual run. If you interrupt the run and restart the execution without changing model configurations or training hyperparameters, the new run will detect the cached graphs in the persistent cache (on-disk) and reload the compiled graphs for execution, avoiding any recompilation time. Changes made to the BERT model configuration (layers, hidden size, attention heads in the get\_model function), batch size (using `--batch_size` option), optimizer or number of workers may trigger graph recompilation. It is best to rerun the pre-compilation step above if these changes are made. You can adjust the following hyperparameters without changing the model and causing recompilation: - Number of global steps to run (`--steps_this_run` option) - Learning rate (`--lr` option) - Gradient accumulation steps > 1 (`--grad_accum_usteps` option). If 1 then there’s no gradient accumulation and the graphs change causing recompilation. ### [Initiating a Training Job](#id9)[#](#initiating-a-training-job "Permalink to this headline") After running the pre-compilation step, continue with the actual phase 1 pretraining by running the following set of commands to launch 32 data parallel distributed training workers on trn1.32xlarge: ``` cd ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain XLA_DOWNCAST_BF16=1 torchrun --nproc_per_node=32 \ dp_bert_large_hf_pretrain_hdf5.py \ --batch_size 16 \ --grad_accum_usteps 32 |& tee run_pretrain_log.txt ``` The script `run_dp_bert_large_hf_pretrain_bf16_s128.sh` is provided in the same BERT tutorial directory for convenience and you can simply run the script to start the training. As the training script launches, you will initially see several console messages indicating that the Neuron Runtime is initializing: ``` Using Neuron Runtime Using Neuron Runtime Using Neuron Runtime Using Neuron Runtime Using Neuron Runtime ... ``` A few moments later, you will see the Training Configuration and Model Configuration in the output: ``` --------TRAINING CONFIG---------- Namespace(batch_size=16, data_dir='~/examples_datasets/ bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128/', debug=False, enable_pt_autocast=False, grad_accum_usteps=32, local_rank=0, lr=0.0004, max_pred_len=20, max_steps=28125, metrics_file='/tmp/test_dict.json', minimal_ckpt=False, num_ckpts_to_keep=1, output_dir='./output', phase1_end_step=28125, phase2=False, resume_ckpt=False, resume_step=-1, seed=12349, seq_len=128, shards_per_ckpt=1, steps_this_run=28125, warmup_steps=2000) ``` ``` --------MODEL CONFIG---------- BertConfig { "_name_or_path": "bert-large-uncased", "architectures": [ "BertForMaskedLM" ], "attention_probs_dropout_prob": 0.1, "classifier_dropout": null, "gradient_checkpointing": false, "hidden_act": "gelu", "hidden_dropout_prob": 0.1, "hidden_size": 1024, "initializer_range": 0.02, "intermediate_size": 4096, "layer_norm_eps": 1e-12, "max_position_embeddings": 512, "model_type": "bert", "num_attention_heads": 16, "num_hidden_layers": 24, "pad_token_id": 0, "position_embedding_type": "absolute", "transformers_version": "4.15.0", "type_vocab_size": 2, "use_cache": true, "vocab_size": 30522 } ``` As the worker processes begin training on the BERT dataset, you will begin to see training metrics and the learning rate logged to the console approximately every training step. The metrics include average\_loss, step\_loss, and throughput: ``` LOG Thu Sep 29 22:30:10 2022 - (0, 78) step_loss : 9.1875 learning_rate : 1.56e-05 throughput : 2873.14 LOG Thu Sep 29 22:30:16 2022 - (0, 79) step_loss : 8.9375 learning_rate : 1.58e-05 throughput : 2878.09 LOG Thu Sep 29 22:30:22 2022 - (0, 80) step_loss : 9.0000 learning_rate : 1.60e-05 throughput : 2875.31 LOG Thu Sep 29 22:30:27 2022 - (0, 81) step_loss : 9.0000 learning_rate : 1.62e-05 throughput : 2877.35 LOG Thu Sep 29 22:30:33 2022 - (0, 82) step_loss : 8.8750 learning_rate : 1.64e-05 throughput : 2872.55 LOG Thu Sep 29 22:30:39 2022 - (0, 83) step_loss : 9.0000 learning_rate : 1.66e-05 throughput : 2876.17 LOG Thu Sep 29 22:30:44 2022 - (0, 84) step_loss : 9.1250 learning_rate : 1.68e-05 throughput : 2872.48 LOG Thu Sep 29 22:30:50 2022 - (0, 85) step_loss : 9.0000 learning_rate : 1.70e-05 throughput : 2873.39 ``` By default, the training script will store all output files under `~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain/output`. The output files consist of the following: - PyTorch model checkpoint files, with names containing the global step of the checkpoint (ckpt\_2000.pt, ckpt\_4000.pt, etc.). Currently, the training script saves a checkpoint after every dataset shard. The frequency of saving checkpoint can be reduced by increasing the number of dataset shards per checkpoint, using option `--shards_per_ckpt`. Furthermore, the number of checkpoints kept at a given time is limited by `--num_ckpts_to_keep` option (currently default to 1). - TensorBoard log files (each training run will store its logs in a subdirectory with prefix `neuron_tblogs_`). ### [Monitoring Progress of the Training Job](#id10)[#](#monitoring-progress-of-the-training-job "Permalink to this headline") Using a single Trn1 instance with 32 NeuronCores, the current BERT phase 1 pretraining will finish in about 45 hours. During this time, you will see the average loss metric begin at about 11.2 and ultimately converge to about 1.4. ### [Monitoring Training Job Progress using neuron-top](#id11)[#](#monitoring-training-job-progress-using-neuron-top "Permalink to this headline") With the training job still running, launch a second SSH connection into the trn1 instance, and use the `neuron-top` command to examine the aggregate NeuronCore utilization. If you have not modified the `--nproc_per_node` option in the run command, you should observe that all 32 NeuronCores are participating in the training job, with utilization fluctuating around 80%. ### [Monitoring Training Job Progress using TensorBoard](#id12)[#](#monitoring-training-job-progress-using-tensorboard "Permalink to this headline") The demo includes TensorBoard-compatible logging, which allows the learning rate and training metrics to be monitored in real-time. By default, the training script logs metrics to the following TensorBoard log directory `~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain/output/neuron_tblogs_<date/time>_<training configs>`. In order to view your training metrics in TensorBoard, first run the following commands in your SSH session: ``` cd ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain tensorboard --logdir ./output ``` Once running, open a new SSH connection to the instance and port-forward TCP port 6006 (ex: `-L 6006:127.0.0.1:6006`). Once the tunnel is established, TensorBoard can then be accessed via web browser at the following URL: [http://localhost:6006](http://localhost:6006/). Please note that you will not be able to access TensorBoard if you disconnect your port-forwarding SSH session to the Trainium instance. ![Image: tensorboard.png](../../../../../_images/tensorboard1.png) ### [Finishing the tutorial](#id13)[#](#finishing-the-tutorial "Permalink to this headline") Once you are ready, there are a couple of options for finishing the BERT pretraining demo: 1. **Allow the training script to run to completion**. If you would like to observe the training script run to completion, it is recommended to launch the training script from a terminal multiplexer such as `tmux` or `screen`, and then detach the session so that the training script can run in the background. With this approach, you can safely let the training script run unattended, without risk of an SSH disconnection causing the training job to stop running. 2. **Stop the training job early**. To stop the training job early, press CTRL-C in the terminal window in which you launched the training script. In some cases, if you manually cancel a job using CTRL-C and then later want to run the job again, you might first need to execute `sudo rmmod neuron; sudo modprobe neuron` in order to reload/reset the Neuron driver. ## [Phase 1 BERT-Large pretraining with Layerwise Adaptive Moments based optimizer (LAMB)](#id14)[#](#phase-1-bert-large-pretraining-with-layerwise-adaptive-moments-based-optimizer-lamb "Permalink to this headline") Sometimes, to reduce the training wall time, you can use higher learning rate and larger global batch size. The approach is discussed in [LARGE BATCH OPTIMIZATION FOR DEEP LEARNING: TRAINING BERT IN 76 MINUTES](https://arxiv.org/pdf/1904.00962.pdf). Tranium supports LAMB, and in this tutorial, we use publicly available XLA-friendly LAMB implemenation from [https://github.com/rwightman/pytorch-image-models/blob/master/timm/optim/lamb.py](https://github.com/rwightman/pytorch-image-models/blob/master/timm/optim/lamb.py). ``` cd ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain torchrun --nproc_per_node=32 \ dp_bert_large_hf_pretrain_hdf5.py \ --max_steps 7032 \ --batch_size 8 \ --optimizer LAMB \ --lr 6e-3 \ --grad_accum_usteps 256 |& tee run_pretrain_log.txt ``` The command-line argument `--optimizer LAMB` is needed, otherwise, the default optimizer AdamW will be used. Besides, you need to use a set of hyper-parameters supporting the larger global batch size (GBS). In this case, we have 64k as GBS for LAMB and use a set of hyper-params similar to [https://github.com/NVIDIA/DeepLearningExamples/blob/master/PyTorch/LanguageModeling/BERT/README.md](https://github.com/NVIDIA/DeepLearningExamples/blob/master/PyTorch/LanguageModeling/BERT/README.md). Given higher GBS from LAMB than AdamW, it takes fewer steps (roughly 7k) to achieve similar level of accuracy as AdamW, which takes more than 28k steps. In addition, you can also use different data types on top of LAMB. Below is an example using the BFloat16 and Stochastic Roundings. ``` cd ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain XLA_DOWNCAST_BF16=1 torchrun --nproc_per_node=32 \ dp_bert_large_hf_pretrain_hdf5.py \ --max_steps 7032 \ --batch_size 16 \ --optimizer LAMB \ --lr 6e-3 \ --grad_accum_usteps 128 |& tee run_pretrain_log.txt ``` The script `run_dp_bert_large_hf_pretrain_bf16_s128_lamb.sh` is provided in the same BERT tutorial directory for convenience and you can simply run the script to start the training. ## [Phase 1 BERT-Large pretraining with PyTorch Autocast (AMP) and stochastic rounding](#id15)[#](#phase-1-bert-large-pretraining-with-pytorch-autocast-amp-and-stochastic-rounding "Permalink to this headline") Besides the [BFloat16 and stochastic rounding in phase 1](#bf16-sr-phase1) , you can also use AMP with stochastic rounding. The detailed background is at [https://pytorch.org/docs/stable/amp.html](https://pytorch.org/docs/stable/amp.html). It uses both data types BFloat16 and Float32, hence provides better performance over Float32. A detailed comparison is available at trn1\_training\_perf. To launch the AMP, one additional command-line argument is needed `--enable_pt_autocast`. `NEURON_RT_STOCHASTIC_ROUNDING_EN=1` enables the stochastic roundings. ``` cd ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain NEURON_RT_STOCHASTIC_ROUNDING_EN=1 \ torchrun --nproc_per_node=32 dp_bert_large_hf_pretrain_hdf5.py \ --batch_size 16 \ --enable_pt_autocast \ --grad_accum_usteps 32 |& tee run_pretrain_log.txt ``` The script `run_dp_bert_large_hf_pretrain_bf16_s128.sh` is provided in the same BERT tutorial directory for convenience and you can simply run the script with `amp` option like `./run_dp_bert_large_hf_pretrain_bf16_s128.sh amp` to start the training with AMP. ## [Phase 1 BERT-Large pretraining on two instances](#id16)[#](#phase-1-bert-large-pretraining-on-two-instances "Permalink to this headline") If you have two trn1.32xlarge instances with EFA-enabled interfaces, using [EFA-enabled security group](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa-start-nccl-base.html#nccl-start-base-setup), and setup using [Install PyTorch Neuron on Trn1](../../setup/pytorch-install.html#pytorch-neuronx-install), you can run multi-instance BERT-Large pretraining. The following example demonstrate running BERT phase 1 pretraining on two instances. To ensure that the global batch size remains at 16384 for phase 1, the gradient accumulation microstep count is reduced by half when the number of instances is 2. NOTE: To run on multiple instances, you will need to use trn1.32xlarge instances and using all 32 NeuronCores on each instance. On the rank-0 Trn1 host (root), run with `--node_rank=0` using torchrun utility, and `--master_addr` set to rank-0 host’s IP address: ``` cd ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain export FI_EFA_USE_DEVICE_RDMA=1 export FI_PROVIDER=efa export BUCKET_CAP_MB=512 export XLA_TRANSFER_SEED_ASYNC=1 XLA_DOWNCAST_BF16=1 torchrun --nproc_per_node=32 --nnodes=2 --node_rank=0 --master_addr=<root IP> --master_port=2020 \ dp_bert_large_hf_pretrain_hdf5.py \ --batch_size 16 \ --grad_accum_usteps 16 |& tee run_pretrain_log.txt ``` On another Trn1 host, run with `--node_rank=1`, and `--master_addr` also set to rank-0 host’s IP address: ``` cd ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain export FI_EFA_USE_DEVICE_RDMA=1 export FI_PROVIDER=efa export BUCKET_CAP_MB=512 export XLA_TRANSFER_SEED_ASYNC=1 XLA_DOWNCAST_BF16=1 torchrun --nproc_per_node=32 --nnodes=2 --node_rank=1 --master_addr=<root IP> --master_port=2020 \ dp_bert_large_hf_pretrain_hdf5.py \ --batch_size 16 \ --grad_accum_usteps 16 |& tee run_pretrain_log.txt ``` It is important to launch rank-0 worker with `--node_rank=0` to avoid hang. To train on multiple instances, it is recommended to use a ParallelCluster. For a ParallelCluster example, please see [Train a model on AWS Trn1 ParallelCluster](https://github.com/aws-neuron/aws-neuron-parallelcluster-samples). ## [Phase 2 BERT-Large pretraining](#id17)[#](#phase-2-bert-large-pretraining "Permalink to this headline") As mentioned above, BERT pretraining happens in two phases. In phase 1, the sequence length is 128. In phase 2, the sequence length increases to 512. This additional training phase will further reduce the pretraining loss and improve the metrics for the fine-tune tasks that usually follow. The setup is very similar to the phase 1, with some differences in training environment and command line arguments highlighted below. ### [Training Environment](#id18)[#](#training-environment "Permalink to this headline") The following dataset and checkpoint are required: - `~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512` is WikiCorpus training dataset that is preprocessed (tokenized and pre-masked) for phase 2. - `~/examples/dp_bert_hf_pretrain/output/ckpt_<phase1_end_step>.pt` is the final checkpoint from phase 1. It’s generated automatically at the end of phase 1 pretraining. For convenience, one can also download the example available at `s3://neuron-s3/training_checkpoints/pytorch/dp_bert_large_hf_pretrain/ckpt_28125.pt`, which is collected after 28125 training steps in phase 1. Phase 2 will continue training by loading this checkpoint. During its progression, phase 2 continues to generate its own checkpoints in output directory, following the naming convention `ckpt_<global_steps>.pt` ### [Initiating a Training Job](#id19)[#](#id1 "Permalink to this headline") To launch the phase 2 pretraining job with AdamW optimizer, run the same python script `dp_bert_large_hf_pretrain_hdf5.py` as before except with different options for phase 2. Again, we are using BFloat16 casting and stochastic rounding by setting environment variable `XLA_DOWNCAST_BF16=1`. For phase 2, we are using global batch size of 32768, with worker device batch size of 2 and gradient accumulation microsteps of 512. The pretokenized dataset is expected to be at `~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512/` following the setup steps above and is set via `--data_dir` option. ``` cd ~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain XLA_DOWNCAST_BF16=1 torchrun --nproc_per_node=32 dp_bert_large_hf_pretrain_hdf5.py \ --data_dir ~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512/ \ --lr 2.8e-4 \ --phase2 \ --resume_ckpt \ --phase1_end_step 28125 \ --batch_size 2 \ --grad_accum_usteps 512 \ --seq_len 512 \ --max_pred_len 80 \ --warmup_steps 781 \ --max_steps 1563 \ |& tee run_pretrain_log_phase2.txt ``` The script `run_dp_bert_large_hf_pretrain_bf16_s128.sh` is provided in the same BERT tutorial directory for convenience and you can simply run the script to start the training with AdamW optimizer. Similarly, you can use LAMB optimizer using the script `run_dp_bert_large_hf_pretrain_bf16_s512_lamb_phase2.sh`. The output below is expected as the job is initiated. Step 28125 is the phase1\_end\_step in this run, which could be different if phase1 training stops at a different global step. ``` Worker 21 resuming from checkpoint ./output/ckpt_28125.pt at step 28125 Worker 23 resuming from checkpoint ./output/ckpt_28125.pt at step 28125 Worker 27 resuming from checkpoint ./output/ckpt_28125.pt at step 28125 Worker 26 resuming from checkpoint ./output/ckpt_28125.pt at step 28125 Worker 20 resuming from checkpoint ./output/ckpt_28125.pt at step 28125 Worker 22 resuming from checkpoint ./output/ckpt_28125.pt at step 28125 --------TRAINING CONFIG---------- Namespace(batch_size=2, data_dir='/home/ec2-user/examples_datasets/ bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512/', debug=False, enable_pt_autocast=False, grad_accum_usteps=512, local_rank=0, lr=0.0002, max_pred_len=80, max_steps=28125, metrics_file='/tmp/test_dict.json', minimal_ckpt=False, num_ckpts_to_keep=1, output_dir='./output', phase1_end_step=28125, phase2=True, resume_ckpt=True, resume_step=-1, seed=12349, seq_len=512, shards_per_ckpt=1, steps_this_run=32, warmup_steps=781) --------MODEL CONFIG---------- BertConfig { "_name_or_path": "bert-large-uncased", "architectures": [ "BertForMaskedLM" ], "attention_probs_dropout_prob": 0.1, "classifier_dropout": null, "gradient_checkpointing": false, "hidden_act": "gelu", "hidden_dropout_prob": 0.1, "hidden_size": 1024, "initializer_range": 0.02, "intermediate_size": 4096, "layer_norm_eps": 1e-12, "max_position_embeddings": 512, "model_type": "bert", "num_attention_heads": 16, "num_hidden_layers": 24, "pad_token_id": 0, "position_embedding_type": "absolute", "transformers_version": "4.15.0", "type_vocab_size": 2, "use_cache": true, "vocab_size": 30522 } ``` As the phase 2 training proceeds, similar metrics to phase 1 will appear on the console, showing the loss, learning rate, and throughput: ``` LOG Tue Sep 27 20:56:35 2022 - (0, 26) step_loss : 4.3438 learning_rate : 6.66e-06 throughput : 494.55 LOG Tue Sep 27 20:57:40 2022 - (0, 27) step_loss : 4.0938 learning_rate : 6.91e-06 throughput : 495.67 LOG Tue Sep 27 20:58:46 2022 - (0, 28) step_loss : 4.1875 learning_rate : 7.17e-06 throughput : 496.18 LOG Tue Sep 27 20:59:53 2022 - (0, 29) step_loss : 4.0000 learning_rate : 7.43e-06 throughput : 495.31 LOG Tue Sep 27 21:00:58 2022 - (0, 30) step_loss : 4.2500 learning_rate : 7.68e-06 throughput : 495.60 LOG Tue Sep 27 21:02:05 2022 - (0, 31) step_loss : 4.3125 learning_rate : 7.94e-06 throughput : 495.50 LOG Tue Sep 27 21:03:10 2022 - (0, 32) step_loss : 4.4688 learning_rate : 8.19e-06 throughput : 496.02 ``` ## [Known issues and limitations](#id24)[#](#known-issues-and-limitations "Permalink to this headline") ### [NaNs seen with transformers version >= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1](#id25)[#](#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1 "Permalink to this headline") When running HuggingFace BERT (any size) fine-tuning tutorial or pretraining tutorial with transformers version >= 4.21.0 and using XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1, you will see NaNs in the loss immediately at the first step. More details on the issue can be found at [pytorch/xla#4152](https://github.com/pytorch/xla/issues/4152). The workaround is to use 4.20.0 or earlier (the tutorials currently recommend version 4.15.0) or add `transformers.modeling_utils.get_parameter_dtype = lambda x: torch.bfloat16` to the Python script. ### [BERT-large compilation limitations](#id26)[#](#bert-large-compilation-limitations "Permalink to this headline") Optimal BERT-large phase 1 (sequence length 128) batch size is currently 8 for FP32 and 16 for full BF16 with stochastic rounding. Optimal BERT-large phase 2 (sequence length 512) batch size is currently 1 for FP32 and 2 for full BF16 with stochastic rounding. ### [BERT-large pretraining with pretokenized dataset hangs when using xm.save](#id27)[#](#bert-large-pretraining-with-pretokenized-dataset-hangs-when-using-xm-save "Permalink to this headline") Currently, BERT-large pretraining with pretokenized dataset hangs when `xm.save` is used outside of the main training loop. ``` Loop through HDF5 sharded dataset files: Train on one HDF5 sharded dataset file Loop through batched samples: Training iteration Save checkpoint using xm.save ``` The reason is that xm.save has a synchronization point. However, the HDF5 shared data files do not have the same number of training samples so the workers cannot all reach xm.save in the same iteration. The workaround is to use `xm._maybe_convert_to_cpu` to ensure tensors are moved to CPU followed by `torch.save` as done in the BERT-large pretraining tutorial: ``` cpu_data = xm._maybe_convert_to_cpu(data) ``` ### [BERT-large two worker pretraining hangs or run out of host memory during checkpointing on trn1.2xlarge](#id28)[#](#bert-large-two-worker-pretraining-hangs-or-run-out-of-host-memory-during-checkpointing-on-trn1-2xlarge "Permalink to this headline") On trn1.2xlarge, where there’s limited host memory and CPU resources, the BERT-large two worker pretraining may hang or run out of host memory during checkpointing. This problem can be worked around by not saving optimizer and LR scheduler states in the checkpoint. This is enabled by `--minimal_ckpt` option of the pretraining script. ### [BERT precompilation using neuron\_parallel\_compile hangs when using torchrun](#id29)[#](#bert-precompilation-using-neuron-parallel-compile-hangs-when-using-torchrun "Permalink to this headline") We use neuron\_parallel\_compile in front of the short run command to do precompilation. However, the following command hangs when running BERT parallel compilation with torchrun: ``` neuron_parallel_compile XLA_DOWNCAST_BF16=1 torchrun --nproc_per_node=32 --nnodes=1 dp_bert_large_hf_pretrain_hdf5.py --steps_this_run 5 ... Updating train metrics in provide results.json file Current data: {'num_workers': 32, 'epoch': 0, 'steps': 5, 'microsteps': 320, 'loss': -22172234.0, 'train_time_minutes': 0.7424166639645894, 'throughput_average': 1839.0391805624324, 'throughput_peak': 1840.0107059878164, 'batch_size': 8, 'max_length': 128} Updating with data: {'num_workers': 32, 'epoch': 0, 'steps': 5, 'microsteps': 320, 'loss': -22172234.0, 'train_time_minutes': 0.7826640844345093, 'throughput_average': 1744.4691285659471, 'throughput_peak': 1745.4964663587539, 'batch_size': 8, 'max_length': 128} Checkpointing... Checkpointing done... (hangs) ``` The fix is to add xm.rendezvous at the end of training to ensure all workers sync up before exiting the script dp\_bert\_large\_pretrain\_hdf5.py. ``` def _mp_fn(index, flags): torch.set_default_tensor_type('torch.FloatTensor') train_bert_hdf5(flags) xm.rendezvous("_mp_fn finished") ``` ### [Reduced multi-node performance with Neuron PyTorch 1.12 (release 2.6)](#id30)[#](#reduced-multi-node-performance-with-neuron-pytorch-1-12-release-2-6 "Permalink to this headline") Default BERT performance on multiple instances is reduced with Neuron PyTorch 1.12 (release 2.6). The workaround is to set the XLA flag XLA\_TRANSFER\_SEED\_ASYNC=1. ## [Troubleshooting](#id31)[#](#troubleshooting "Permalink to this headline") The following are troubleshooting tips related to this tutorial. See [PyTorch Neuron on Trainium Troubleshooting Guide](../../training-troubleshooting.html#pytorch-neuron-traning-troubleshooting) for additional troubleshooting tips. ### [ModuleNotFoundError: No module named ‘torch’ , ‘torch\_xla’, ‘transformers’, etc](#id32)[#](#modulenotfounderror-no-module-named-torch-torch-xla-transformers-etc "Permalink to this headline") If you encounter ‘ModuleNotFoundError’ messages while attempting to run the demo scripts, please ensure that you have activated the appropriate Python _virtualenv_ which contains all of the demo dependencies: ``` cd ~ source <python virtual environment path>/bin/activate ``` _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Hugging Face BERT Pretraining Tutorial — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Multi-Layer Perceptron Training Tutorial" href="mlp.html"> <link rel="prev" title="Tutorials for Training(torch-neuronx)" href="tutorials-training-torch-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/tutorials/training/bert", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-training-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"><!-- Inserted RTD Footer --> <div class="injected"> <div class="rst-versions rst-badge" data-toggle="rst-versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book">&nbsp;</span> v: v2.14.1 <span class="fa fa-caret-down"></span> </span> <div class="rst-other-versions"> <dl> <dt>Versions</dt> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/torch/torch-neuronx/tutorials/training/bert.html">latest</a> </dd> <dd class="rtd-current-item"> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.14.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.14.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.13.2/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.13.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.13.1/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.13.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.13.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.13.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.12.2/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.12.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.12.1/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.12.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.12.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.12.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.11.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.11.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.10.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.10.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.9.1/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.9.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.9.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.9.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.8.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.8.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.7.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.7.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.6.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.6.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.5.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.5.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.4.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.4.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.3.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v2.3.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.19.2/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.19.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.19.1/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.19.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.19.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.19.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.18.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.18.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.17.2/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.17.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.17.1/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.17.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.17.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.17.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.3/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.16.3</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.2/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.16.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.1/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.16.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.0/frameworks/torch/torch-neuronx/tutorials/training/bert.html">v1.16.0</a> </dd> </dl> <dl> <dt>Downloads</dt> <dd><a href="//awsdocs-neuron.readthedocs-hosted.com/_/downloads/en/v2.14.1/pdf/">PDF</a></dd> </dl> <dl> <dt>On GitHub</dt> <dd> <a href="https://github.com/aws/aws-neuron-sdk/blob/v2.14.1//frameworks/torch/torch-neuronx/tutorials/training/bert.rst">View</a> </dd> </dl> <hr> <div> <div> Documentation hosted by <a href="https://readthedocs.com">Read the Docs</a> </div> </div> </div> </div> </div> </div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/tutorials/training/bert.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/bert.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/tutorials/training/bert.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-1-bert-large-pretraining"> Phase 1 BERT-Large pretraining </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#setting-up-the-training-environment-on-trn1-32xlarge"> Setting up the training environment on trn1.32xlarge </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#downloading-tokenized-and-sharded-dataset-files"> Downloading tokenized and sharded dataset files </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#number-of-workers"> Number of workers </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bfloat16-and-stochastic-rounding-in-phase-1"> BFloat16 and stochastic rounding in phase 1 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pre-compilation"> Pre-compilation </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#initiating-a-training-job"> Initiating a Training Job </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#monitoring-progress-of-the-training-job"> Monitoring Progress of the Training Job </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#monitoring-training-job-progress-using-neuron-top"> Monitoring Training Job Progress using neuron-top </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#monitoring-training-job-progress-using-tensorboard"> Monitoring Training Job Progress using TensorBoard </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#finishing-the-tutorial"> Finishing the tutorial </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-1-bert-large-pretraining-with-layerwise-adaptive-moments-based-optimizer-lamb"> Phase 1 BERT-Large pretraining with Layerwise Adaptive Moments based optimizer (LAMB) </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-1-bert-large-pretraining-with-pytorch-autocast-amp-and-stochastic-rounding"> Phase 1 BERT-Large pretraining with PyTorch Autocast (AMP) and stochastic rounding </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-1-bert-large-pretraining-on-two-instances"> Phase 1 BERT-Large pretraining on two instances </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-2-bert-large-pretraining"> Phase 2 BERT-Large pretraining </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#training-environment"> Training Environment </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Initiating a Training Job </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tools"> Tools </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-ls"> neuron-ls </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-top"> neuron-top </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#generating-tokenized-and-sharded-dataset-files"> Generating tokenized and sharded dataset files </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known issues and limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bert-large-compilation-limitations"> BERT-large compilation limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bert-large-pretraining-with-pretokenized-dataset-hangs-when-using-xm-save"> BERT-large pretraining with pretokenized dataset hangs when using xm.save </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bert-large-two-worker-pretraining-hangs-or-run-out-of-host-memory-during-checkpointing-on-trn1-2xlarge"> BERT-large two worker pretraining hangs or run out of host memory during checkpointing on trn1.2xlarge </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bert-precompilation-using-neuron-parallel-compile-hangs-when-using-torchrun"> BERT precompilation using neuron_parallel_compile hangs when using torchrun </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#reduced-multi-node-performance-with-neuron-pytorch-1-12-release-2-6"> Reduced multi-node performance with Neuron PyTorch 1.12 (release 2.6) </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#troubleshooting"> Troubleshooting </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#modulenotfounderror-no-module-named-torch-torch-xla-transformers-etc"> ModuleNotFoundError: No module named ‘torch’ , ‘torch_xla’, ‘transformers’, etc </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Hugging Face BERT Pretraining Tutorial</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-1-bert-large-pretraining"> Phase 1 BERT-Large pretraining </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#setting-up-the-training-environment-on-trn1-32xlarge"> Setting up the training environment on trn1.32xlarge </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#downloading-tokenized-and-sharded-dataset-files"> Downloading tokenized and sharded dataset files </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#number-of-workers"> Number of workers </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bfloat16-and-stochastic-rounding-in-phase-1"> BFloat16 and stochastic rounding in phase 1 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#pre-compilation"> Pre-compilation </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#initiating-a-training-job"> Initiating a Training Job </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#monitoring-progress-of-the-training-job"> Monitoring Progress of the Training Job </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#monitoring-training-job-progress-using-neuron-top"> Monitoring Training Job Progress using neuron-top </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#monitoring-training-job-progress-using-tensorboard"> Monitoring Training Job Progress using TensorBoard </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#finishing-the-tutorial"> Finishing the tutorial </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-1-bert-large-pretraining-with-layerwise-adaptive-moments-based-optimizer-lamb"> Phase 1 BERT-Large pretraining with Layerwise Adaptive Moments based optimizer (LAMB) </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-1-bert-large-pretraining-with-pytorch-autocast-amp-and-stochastic-rounding"> Phase 1 BERT-Large pretraining with PyTorch Autocast (AMP) and stochastic rounding </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-1-bert-large-pretraining-on-two-instances"> Phase 1 BERT-Large pretraining on two instances </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#phase-2-bert-large-pretraining"> Phase 2 BERT-Large pretraining </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#training-environment"> Training Environment </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Initiating a Training Job </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tools"> Tools </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-ls"> neuron-ls </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-top"> neuron-top </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#generating-tokenized-and-sharded-dataset-files"> Generating tokenized and sharded dataset files </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known issues and limitations </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bert-large-compilation-limitations"> BERT-large compilation limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bert-large-pretraining-with-pretokenized-dataset-hangs-when-using-xm-save"> BERT-large pretraining with pretokenized dataset hangs when using xm.save </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bert-large-two-worker-pretraining-hangs-or-run-out-of-host-memory-during-checkpointing-on-trn1-2xlarge"> BERT-large two worker pretraining hangs or run out of host memory during checkpointing on trn1.2xlarge </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bert-precompilation-using-neuron-parallel-compile-hangs-when-using-torchrun"> BERT precompilation using neuron_parallel_compile hangs when using torchrun </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#reduced-multi-node-performance-with-neuron-pytorch-1-12-release-2-6"> Reduced multi-node performance with Neuron PyTorch 1.12 (release 2.6) </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#troubleshooting"> Troubleshooting </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#modulenotfounderror-no-module-named-torch-torch-xla-transformers-etc"> ModuleNotFoundError: No module named ‘torch’ , ‘torch_xla’, ‘transformers’, etc </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="hugging-face-bert-pretraining-tutorial"> <span id="hf-bert-pretraining-tutorial"></span><h1>Hugging Face BERT Pretraining Tutorial<a class="headerlink" href="#hugging-face-bert-pretraining-tutorial" title="Permalink to this headline">#</a></h1> <p>This tutorial explains how to run Hugging Face BERT-Large model pretraining on Trainium using PyTorch Neuron.</p> <p>The Hugging Face BERT pretraining example demonstrates the steps required to perform single-node, multi-accelerator PyTorch model training using the new AWS EC2 Trn1 (Trainium) instances and the AWS Neuron SDK. This tutorial is an adaptation of an existing <a class="reference external" href="https://github.com/NVIDIA/DeepLearningExamples/blob/master/PyTorch/LanguageModeling/BERT/run_pretraining.py">BERT example</a> with the following important characteristics:</p> <ul class="simple"> <li><p>Framework: PyTorch/XLA</p></li> <li><p>Model: Hugging Face BertForPreTraining</p></li> <li><p>Optimizer: AdamW, LAMB (Layerwise Adaptive Moments optimizer)</p></li> <li><p>Scheduler: Hugging Face’s get_linear_schedule_with_warmup</p></li> <li><p>Allreduce occurs before optimizer step, after gradient accumulations (following DeepSpeed’s Smart Gradient Accumulation)</p></li> <li><p>Training data types: Float32, full BFloat16 casting and Stochastic Rounding (SR), PyTorch Autocast (Automatic Mixed Precision or AMP) and SR</p></li> </ul> <p>As done in the original BERT paper, BERT pretraining happens in two phases. In the first phase (phase 1) BERT maximum sequence length is fixed at 128 tokens, while in phase 2 it is fixed at 512 tokens.</p> <p>Neuron provides access to Trainium devices through an extension of PyTorch/XLA - a library that includes the familiar PyTorch interface along with XLA-specific additions. For additional details relating to PyTorch/XLA, please refer to the <a class="reference external" href="https://pytorch.org/xla/">official PyTorch/XLA documentation</a>.</p> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#phase-1-bert-large-pretraining" id="id3">Phase 1 BERT-Large pretraining</a></p> <ul> <li><p><a class="reference internal" href="#setting-up-the-training-environment-on-trn1-32xlarge" id="id4">Setting up the training environment on trn1.32xlarge</a></p></li> <li><p><a class="reference internal" href="#downloading-tokenized-and-sharded-dataset-files" id="id5">Downloading tokenized and sharded dataset files</a></p></li> <li><p><a class="reference internal" href="#number-of-workers" id="id6">Number of workers</a></p></li> <li><p><a class="reference internal" href="#bfloat16-and-stochastic-rounding-in-phase-1" id="id7">BFloat16 and stochastic rounding in phase 1</a></p></li> <li><p><a class="reference internal" href="#pre-compilation" id="id8">Pre-compilation</a></p></li> <li><p><a class="reference internal" href="#initiating-a-training-job" id="id9">Initiating a Training Job</a></p></li> <li><p><a class="reference internal" href="#monitoring-progress-of-the-training-job" id="id10">Monitoring Progress of the Training Job</a></p></li> <li><p><a class="reference internal" href="#monitoring-training-job-progress-using-neuron-top" id="id11">Monitoring Training Job Progress using neuron-top</a></p></li> <li><p><a class="reference internal" href="#monitoring-training-job-progress-using-tensorboard" id="id12">Monitoring Training Job Progress using TensorBoard</a></p></li> <li><p><a class="reference internal" href="#finishing-the-tutorial" id="id13">Finishing the tutorial</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#phase-1-bert-large-pretraining-with-layerwise-adaptive-moments-based-optimizer-lamb" id="id14">Phase 1 BERT-Large pretraining with Layerwise Adaptive Moments based optimizer (LAMB)</a></p></li> <li><p><a class="reference internal" href="#phase-1-bert-large-pretraining-with-pytorch-autocast-amp-and-stochastic-rounding" id="id15">Phase 1 BERT-Large pretraining with PyTorch Autocast (AMP) and stochastic rounding</a></p></li> <li><p><a class="reference internal" href="#phase-1-bert-large-pretraining-on-two-instances" id="id16">Phase 1 BERT-Large pretraining on two instances</a></p></li> <li><p><a class="reference internal" href="#phase-2-bert-large-pretraining" id="id17">Phase 2 BERT-Large pretraining</a></p> <ul> <li><p><a class="reference internal" href="#training-environment" id="id18">Training Environment</a></p></li> <li><p><a class="reference internal" href="#id1" id="id19">Initiating a Training Job</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#tools" id="id20">Tools</a></p> <ul> <li><p><a class="reference internal" href="#neuron-ls" id="id21">neuron-ls</a></p></li> <li><p><a class="reference internal" href="#neuron-top" id="id22">neuron-top</a></p></li> <li><p><a class="reference internal" href="#generating-tokenized-and-sharded-dataset-files" id="id23">Generating tokenized and sharded dataset files</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#known-issues-and-limitations" id="id24">Known issues and limitations</a></p> <ul> <li><p><a class="reference internal" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1" id="id25">NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1</a></p></li> <li><p><a class="reference internal" href="#bert-large-compilation-limitations" id="id26">BERT-large compilation limitations</a></p></li> <li><p><a class="reference internal" href="#bert-large-pretraining-with-pretokenized-dataset-hangs-when-using-xm-save" id="id27">BERT-large pretraining with pretokenized dataset hangs when using xm.save</a></p></li> <li><p><a class="reference internal" href="#bert-large-two-worker-pretraining-hangs-or-run-out-of-host-memory-during-checkpointing-on-trn1-2xlarge" id="id28">BERT-large two worker pretraining hangs or run out of host memory during checkpointing on trn1.2xlarge</a></p></li> <li><p><a class="reference internal" href="#bert-precompilation-using-neuron-parallel-compile-hangs-when-using-torchrun" id="id29">BERT precompilation using neuron_parallel_compile hangs when using torchrun</a></p></li> <li><p><a class="reference internal" href="#reduced-multi-node-performance-with-neuron-pytorch-1-12-release-2-6" id="id30">Reduced multi-node performance with Neuron PyTorch 1.12 (release 2.6)</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#troubleshooting" id="id31">Troubleshooting</a></p> <ul> <li><p><a class="reference internal" href="#modulenotfounderror-no-module-named-torch-torch-xla-transformers-etc" id="id32">ModuleNotFoundError: No module named ‘torch’ , ‘torch_xla’, ‘transformers’, etc</a></p></li> </ul> </li> </ul> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Logs used in tutorials do not present latest performance numbers</p> <p>For latest performance numbers visit <a class="reference internal" href="../../../../../general/benchmarks/index.html#benchmark"><span class="std std-ref">Neuron Performance</span></a></p> </div> <div class="section" id="phase-1-bert-large-pretraining"> <h2><a class="toc-backref" href="#id3">Phase 1 BERT-Large pretraining</a><a class="headerlink" href="#phase-1-bert-large-pretraining" title="Permalink to this headline">#</a></h2> <div class="section" id="setting-up-the-training-environment-on-trn1-32xlarge"> <h3><a class="toc-backref" href="#id4">Setting up the training environment on trn1.32xlarge</a><a class="headerlink" href="#setting-up-the-training-environment-on-trn1-32xlarge" title="Permalink to this headline">#</a></h3> <p>The BERT training script <code class="docutils literal notranslate"><span class="pre">dp_bert_large_hf_pretrain_hdf5.py</span></code> can run on a Trainium instance (trn1.32xlarge) that contains the appropriate Neuron runtime and Python dependencies.</p> <p>First, on a trn1.32xlarge instance, follow the installation instructions at:</p> <p><a class="reference internal" href="../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx"><span class="std std-ref">Install PyTorch Neuron on Trn1</span></a></p> <p>Please set the storage of instance to <em>512GB</em> or more if you intent to run multiple experiments and save many checkpoints.</p> <p>For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>~/aws_neuron_venv_pytorch/bin/activate </pre></div> </div> <p>Next, clone the AWS Neuron Samples repository and install requirements in the BERT tutorial directory <code class="docutils literal notranslate"><span class="pre">aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain</span></code>:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/ git<span class="w"> </span>clone<span class="w"> </span>https://github.com/aws-neuron/aws-neuron-samples.git python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain/requirements.txt </pre></div> </div> </div> <div class="section" id="downloading-tokenized-and-sharded-dataset-files"> <h3><a class="toc-backref" href="#id5">Downloading tokenized and sharded dataset files</a><a class="headerlink" href="#downloading-tokenized-and-sharded-dataset-files" title="Permalink to this headline">#</a></h3> <p>To download the tokenized and sharded dataset files needed for this tutorial, please run the following commands:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>mkdir<span class="w"> </span>-p<span class="w"> </span>~/examples_datasets/ <span class="nb">pushd</span><span class="w"> </span>~/examples_datasets/ aws<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://neuron-s3/training_datasets/bert_pretrain_wikicorpus_tokenized_hdf5/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128.tar<span class="w"> </span>.<span class="w"> </span>--no-sign-request tar<span class="w"> </span>-xf<span class="w"> </span>bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128.tar rm<span class="w"> </span>bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128.tar aws<span class="w"> </span>s3<span class="w"> </span>cp<span class="w"> </span>s3://neuron-s3/training_datasets/bert_pretrain_wikicorpus_tokenized_hdf5/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512.tar<span class="w"> </span>.<span class="w"> </span>--no-sign-request tar<span class="w"> </span>-xf<span class="w"> </span>bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512.tar rm<span class="w"> </span>bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512.tar <span class="nb">popd</span> </pre></div> </div> <p><code class="docutils literal notranslate"><span class="pre">~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128</span></code> will now have the tokenized and sharded dataset files for phase 1 pretraining and <code class="docutils literal notranslate"><span class="pre">~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512</span></code> for phase 2 pretraining.</p> </div> <div class="section" id="number-of-workers"> <h3><a class="toc-backref" href="#id6">Number of workers</a><a class="headerlink" href="#number-of-workers" title="Permalink to this headline">#</a></h3> <p>You will be using torchrun (<a class="reference external" href="https://pytorch.org/docs/stable/elastic/run.html">PyTorch’s Elastic Launch</a>) to run some of the commands in this tutorial. When running the training script, you can configure the number of NeuronCores to use for training by using torchrun’s <code class="xref std std-option docutils literal notranslate"><span class="pre">--nproc_per_node</span></code> option. In this tutorial, we use 32 NeuronCores on trn1.32xlarge.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Currently Neuron Runtime only support 1 and 2 worker configurations on trn1.2xlarge and 1, 2, 8, and 32-worker configurations on trn1.32xlarge.</p> </div> </div> <div class="section" id="bfloat16-and-stochastic-rounding-in-phase-1"> <span id="bf16-sr-phase1"></span><h3><a class="toc-backref" href="#id7">BFloat16 and stochastic rounding in phase 1</a><a class="headerlink" href="#bfloat16-and-stochastic-rounding-in-phase-1" title="Permalink to this headline">#</a></h3> <p>Phase 1 pretraining performance can be increased by using BFloat16 casting and stochastic rounding. BFloat16 casting and stochastic rounding can be enabled by setting environment variable <code class="docutils literal notranslate"><span class="pre">XLA_USE_BF16=1</span></code> when launching the pretraining job. <code class="docutils literal notranslate"><span class="pre">XLA_DOWNCAST_BF16=1</span></code> can also be used instead of <code class="docutils literal notranslate"><span class="pre">XLA_USE_BF16=1</span></code> to preserve part of the training loop in FP32. Here we use <code class="docutils literal notranslate"><span class="pre">XLA_DOWNCAST_BF16=1</span></code> to ensure smooth loss curve when loss averaging is used. We also preserve the optimizer states in FP32 using a modified HuggingFace AdamW implementation in order to match FP32 loss with BFloat16. To achieve maximum performance while maintaining loss convergence characteristics, we are using batch size of 16 and gradient accumulation microsteps of 32 to maintain global batch size of 16384 for phase 1. The batch size and gradient accumulation microstep changes can be set by launching the BERT pretraining script <code class="docutils literal notranslate"><span class="pre">dp_bert_large_hf_pretrain_hdf5.py</span></code> with command-line arguments <code class="docutils literal notranslate"><span class="pre">--batch_size=16</span> <span class="pre">--grad_accum_usteps=32</span></code>, as seen in the following steps.</p> <p>Another option with BFloat16 using PyTorch AutoCast (Automatic Mixed Precision or AMP) is covered at <a class="reference internal" href="#amp-sr-phase1"><span class="std std-ref">Phase 1 BERT-Large pretraining with PyTorch Autocast (AMP) and stochastic rounding</span></a>.</p> </div> <div class="section" id="pre-compilation"> <h3><a class="toc-backref" href="#id8">Pre-compilation</a><a class="headerlink" href="#pre-compilation" title="Permalink to this headline">#</a></h3> <p>PyTorch Neuron evaluates operations lazily during execution of the training loops, which means it builds a symbolic graph in the background and the graph is executed in hardware only when the tensor is printed, transfered to CPU, or <code class="docutils literal notranslate"><span class="pre">xm.mark_step()</span></code> is encountered (<code class="docutils literal notranslate"><span class="pre">xm.mark_step()</span></code> is implicitly called by <code class="docutils literal notranslate"><span class="pre">pl.MpDeviceLoader/pl.ParallelLoader</span></code>). During execution of the training loops, PyTorch Neuron can build multiple graphs depending on the number of conditional paths taken. For BERT-Large pretraining, PyTorch Neuron builds multiple unique graphs that should be compiled before running on the NeuronCores. PyTorch Neuron will compile those graphs only if they are not in the XLA in-memory cache or the persistent cache. To reduce the compilation time of these graphs, you can pre-compile those graphs using the utility <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> (provided by the <code class="docutils literal notranslate"><span class="pre">libneuronxla</span></code> package, a transitive dependency of <code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) as shown:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain neuron_parallel_compile<span class="w"> </span><span class="nv">XLA_DOWNCAST_BF16</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span><span class="se">\</span> dp_bert_large_hf_pretrain_hdf5.py<span class="w"> </span><span class="se">\</span> --steps_this_run<span class="w"> </span><span class="m">10</span><span class="w"> </span><span class="se">\</span> --batch_size<span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="se">\</span> --grad_accum_usteps<span class="w"> </span><span class="m">32</span><span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>compile_log.txt </pre></div> </div> <p>This command performs a fast trial run of the training script to build graphs and then do parallel compilations on those graphs using multiple processes of Neuron Compiler before populating the on-disk persistent cache with compiled graphs. This helps make the actual training run faster because the compiled graphs will loaded from the persistent cache. Currently it takes ~13 minutes to compile the BERT-Large model training step using the pre-compilation script (compare to ~40 minute if not using the pre-compilation script). Note that the command above specifies 32 NeuronCores for trn1.32xlarge via –nproc_per_node option.</p> <p>The script <code class="docutils literal notranslate"><span class="pre">run_dp_bert_large_hf_pretrain_bf16_s128.sh</span></code> is provided in the same BERT tutorial directory for convenience and you can simply run the script using <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span> <span class="pre">./run_dp_bert_large_hf_pretrain_bf16_s128.sh</span></code> to start the precompilation.</p> <p>The pretokenized dataset is expected to be at <code class="docutils literal notranslate"><span class="pre">~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128/</span></code> by default (see above for downloading instructions) and can be changed via the <code class="docutils literal notranslate"><span class="pre">--data_dir</span></code> option.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The trial run during pre-compilation currently outputs invalid loss numbers. Please disregard them.</p> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The command after <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> should match the actual run command, except for the option <code class="xref std std-option docutils literal notranslate"><span class="pre">--steps_this_run</span></code> which shortens the trial run just enough to allow the tool to build all the graphs needed for the actual run.</p> </div> <p>If you interrupt the run and restart the execution without changing model configurations or training hyperparameters, the new run will detect the cached graphs in the persistent cache (on-disk) and reload the compiled graphs for execution, avoiding any recompilation time.</p> <p>Changes made to the BERT model configuration (layers, hidden size, attention heads in the get_model function), batch size (using <code class="xref std std-option docutils literal notranslate"><span class="pre">--batch_size</span></code> option), optimizer or number of workers may trigger graph recompilation. It is best to rerun the pre-compilation step above if these changes are made.</p> <p>You can adjust the following hyperparameters without changing the model and causing recompilation:</p> <ul class="simple"> <li><p>Number of global steps to run (<code class="xref std std-option docutils literal notranslate"><span class="pre">--steps_this_run</span></code> option)</p></li> <li><p>Learning rate (<code class="xref std std-option docutils literal notranslate"><span class="pre">--lr</span></code> option)</p></li> <li><p>Gradient accumulation steps &gt; 1 (<code class="xref std std-option docutils literal notranslate"><span class="pre">--grad_accum_usteps</span></code> option). If 1 then there’s no gradient accumulation and the graphs change causing recompilation.</p></li> </ul> </div> <div class="section" id="initiating-a-training-job"> <h3><a class="toc-backref" href="#id9">Initiating a Training Job</a><a class="headerlink" href="#initiating-a-training-job" title="Permalink to this headline">#</a></h3> <p>After running the pre-compilation step, continue with the actual phase 1 pretraining by running the following set of commands to launch 32 data parallel distributed training workers on trn1.32xlarge:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain <span class="nv">XLA_DOWNCAST_BF16</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span><span class="se">\</span> dp_bert_large_hf_pretrain_hdf5.py<span class="w"> </span><span class="se">\</span> --batch_size<span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="se">\</span> --grad_accum_usteps<span class="w"> </span><span class="m">32</span><span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>run_pretrain_log.txt </pre></div> </div> <p>The script <code class="docutils literal notranslate"><span class="pre">run_dp_bert_large_hf_pretrain_bf16_s128.sh</span></code> is provided in the same BERT tutorial directory for convenience and you can simply run the script to start the training.</p> <p>As the training script launches, you will initially see several console messages indicating that the Neuron Runtime is initializing:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Using<span class="w"> </span>Neuron<span class="w"> </span>Runtime Using<span class="w"> </span>Neuron<span class="w"> </span>Runtime Using<span class="w"> </span>Neuron<span class="w"> </span>Runtime Using<span class="w"> </span>Neuron<span class="w"> </span>Runtime Using<span class="w"> </span>Neuron<span class="w"> </span>Runtime ... </pre></div> </div> <p>A few moments later, you will see the Training Configuration and Model Configuration in the output:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>--------TRAINING<span class="w"> </span>CONFIG---------- Namespace<span class="o">(</span><span class="nv">batch_size</span><span class="o">=</span><span class="m">16</span>,<span class="w"> </span><span class="nv">data_dir</span><span class="o">=</span><span class="s1">'~/examples_datasets/</span> <span class="s1">bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128/'</span>,<span class="w"> </span><span class="nv">debug</span><span class="o">=</span>False, <span class="nv">enable_pt_autocast</span><span class="o">=</span>False,<span class="w"> </span><span class="nv">grad_accum_usteps</span><span class="o">=</span><span class="m">32</span>,<span class="w"> </span><span class="nv">local_rank</span><span class="o">=</span><span class="m">0</span>,<span class="w"> </span><span class="nv">lr</span><span class="o">=</span><span class="m">0</span>.0004, <span class="nv">max_pred_len</span><span class="o">=</span><span class="m">20</span>,<span class="w"> </span><span class="nv">max_steps</span><span class="o">=</span><span class="m">28125</span>,<span class="w"> </span><span class="nv">metrics_file</span><span class="o">=</span><span class="s1">'/tmp/test_dict.json'</span>, <span class="nv">minimal_ckpt</span><span class="o">=</span>False,<span class="w"> </span><span class="nv">num_ckpts_to_keep</span><span class="o">=</span><span class="m">1</span>,<span class="w"> </span><span class="nv">output_dir</span><span class="o">=</span><span class="s1">'./output'</span>, <span class="nv">phase1_end_step</span><span class="o">=</span><span class="m">28125</span>,<span class="w"> </span><span class="nv">phase2</span><span class="o">=</span>False,<span class="w"> </span><span class="nv">resume_ckpt</span><span class="o">=</span>False,<span class="w"> </span><span class="nv">resume_step</span><span class="o">=</span>-1, <span class="nv">seed</span><span class="o">=</span><span class="m">12349</span>,<span class="w"> </span><span class="nv">seq_len</span><span class="o">=</span><span class="m">128</span>,<span class="w"> </span><span class="nv">shards_per_ckpt</span><span class="o">=</span><span class="m">1</span>,<span class="w"> </span><span class="nv">steps_this_run</span><span class="o">=</span><span class="m">28125</span>,<span class="w"> </span><span class="nv">warmup_steps</span><span class="o">=</span><span class="m">2000</span><span class="o">)</span> </pre></div> </div> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>--------MODEL<span class="w"> </span>CONFIG---------- BertConfig<span class="w"> </span><span class="o">{</span> <span class="s2">"_name_or_path"</span>:<span class="w"> </span><span class="s2">"bert-large-uncased"</span>, <span class="s2">"architectures"</span>:<span class="w"> </span><span class="o">[</span> <span class="s2">"BertForMaskedLM"</span> <span class="o">]</span>, <span class="s2">"attention_probs_dropout_prob"</span>:<span class="w"> </span><span class="m">0</span>.1, <span class="s2">"classifier_dropout"</span>:<span class="w"> </span>null, <span class="s2">"gradient_checkpointing"</span>:<span class="w"> </span>false, <span class="s2">"hidden_act"</span>:<span class="w"> </span><span class="s2">"gelu"</span>, <span class="s2">"hidden_dropout_prob"</span>:<span class="w"> </span><span class="m">0</span>.1, <span class="s2">"hidden_size"</span>:<span class="w"> </span><span class="m">1024</span>, <span class="s2">"initializer_range"</span>:<span class="w"> </span><span class="m">0</span>.02, <span class="s2">"intermediate_size"</span>:<span class="w"> </span><span class="m">4096</span>, <span class="s2">"layer_norm_eps"</span>:<span class="w"> </span>1e-12, <span class="s2">"max_position_embeddings"</span>:<span class="w"> </span><span class="m">512</span>, <span class="s2">"model_type"</span>:<span class="w"> </span><span class="s2">"bert"</span>, <span class="s2">"num_attention_heads"</span>:<span class="w"> </span><span class="m">16</span>, <span class="s2">"num_hidden_layers"</span>:<span class="w"> </span><span class="m">24</span>, <span class="s2">"pad_token_id"</span>:<span class="w"> </span><span class="m">0</span>, <span class="s2">"position_embedding_type"</span>:<span class="w"> </span><span class="s2">"absolute"</span>, <span class="s2">"transformers_version"</span>:<span class="w"> </span><span class="s2">"4.15.0"</span>, <span class="s2">"type_vocab_size"</span>:<span class="w"> </span><span class="m">2</span>, <span class="s2">"use_cache"</span>:<span class="w"> </span>true, <span class="s2">"vocab_size"</span>:<span class="w"> </span><span class="m">30522</span> <span class="o">}</span> </pre></div> </div> <p>As the worker processes begin training on the BERT dataset, you will begin to see training metrics and the learning rate logged to the console approximately every training step. The metrics include average_loss, step_loss, and throughput:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>LOG<span class="w"> </span>Thu<span class="w"> </span>Sep<span class="w"> </span><span class="m">29</span><span class="w"> </span><span class="m">22</span>:30:10<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">78</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">9</span>.1875<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.56e-05<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">2873</span>.14 LOG<span class="w"> </span>Thu<span class="w"> </span>Sep<span class="w"> </span><span class="m">29</span><span class="w"> </span><span class="m">22</span>:30:16<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">79</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">8</span>.9375<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.58e-05<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">2878</span>.09 LOG<span class="w"> </span>Thu<span class="w"> </span>Sep<span class="w"> </span><span class="m">29</span><span class="w"> </span><span class="m">22</span>:30:22<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">80</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">9</span>.0000<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.60e-05<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">2875</span>.31 LOG<span class="w"> </span>Thu<span class="w"> </span>Sep<span class="w"> </span><span class="m">29</span><span class="w"> </span><span class="m">22</span>:30:27<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">81</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">9</span>.0000<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.62e-05<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">2877</span>.35 LOG<span class="w"> </span>Thu<span class="w"> </span>Sep<span class="w"> </span><span class="m">29</span><span class="w"> </span><span class="m">22</span>:30:33<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">82</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">8</span>.8750<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.64e-05<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">2872</span>.55 LOG<span class="w"> </span>Thu<span class="w"> </span>Sep<span class="w"> </span><span class="m">29</span><span class="w"> </span><span class="m">22</span>:30:39<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">83</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">9</span>.0000<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.66e-05<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">2876</span>.17 LOG<span class="w"> </span>Thu<span class="w"> </span>Sep<span class="w"> </span><span class="m">29</span><span class="w"> </span><span class="m">22</span>:30:44<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">84</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">9</span>.1250<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.68e-05<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">2872</span>.48 LOG<span class="w"> </span>Thu<span class="w"> </span>Sep<span class="w"> </span><span class="m">29</span><span class="w"> </span><span class="m">22</span>:30:50<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">85</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">9</span>.0000<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">1</span>.70e-05<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">2873</span>.39 </pre></div> </div> <p>By default, the training script will store all output files under <code class="docutils literal notranslate"><span class="pre">~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain/output</span></code>. The output files consist of the following:</p> <ul class="simple"> <li><p>PyTorch model checkpoint files, with names containing the global step of the checkpoint (ckpt_2000.pt, ckpt_4000.pt, etc.). Currently, the training script saves a checkpoint after every dataset shard. The frequency of saving checkpoint can be reduced by increasing the number of dataset shards per checkpoint, using option <code class="xref std std-option docutils literal notranslate"><span class="pre">--shards_per_ckpt</span></code>. Furthermore, the number of checkpoints kept at a given time is limited by <code class="xref std std-option docutils literal notranslate"><span class="pre">--num_ckpts_to_keep</span></code> option (currently default to 1).</p></li> <li><p>TensorBoard log files (each training run will store its logs in a subdirectory with prefix <code class="docutils literal notranslate"><span class="pre">neuron_tblogs_</span></code>).</p></li> </ul> </div> <div class="section" id="monitoring-progress-of-the-training-job"> <h3><a class="toc-backref" href="#id10">Monitoring Progress of the Training Job</a><a class="headerlink" href="#monitoring-progress-of-the-training-job" title="Permalink to this headline">#</a></h3> <p>Using a single Trn1 instance with 32 NeuronCores, the current BERT phase 1 pretraining will finish in about 45 hours. During this time, you will see the average loss metric begin at about 11.2 and ultimately converge to about 1.4.</p> </div> <div class="section" id="monitoring-training-job-progress-using-neuron-top"> <h3><a class="toc-backref" href="#id11">Monitoring Training Job Progress using neuron-top</a><a class="headerlink" href="#monitoring-training-job-progress-using-neuron-top" title="Permalink to this headline">#</a></h3> <p>With the training job still running, launch a second SSH connection into the trn1 instance, and use the <code class="docutils literal notranslate"><span class="pre">neuron-top</span></code> command to examine the aggregate NeuronCore utilization. If you have not modified the <code class="xref std std-option docutils literal notranslate"><span class="pre">--nproc_per_node</span></code> option in the run command, you should observe that all 32 NeuronCores are participating in the training job, with utilization fluctuating around 80%.</p> </div> <div class="section" id="monitoring-training-job-progress-using-tensorboard"> <h3><a class="toc-backref" href="#id12">Monitoring Training Job Progress using TensorBoard</a><a class="headerlink" href="#monitoring-training-job-progress-using-tensorboard" title="Permalink to this headline">#</a></h3> <p>The demo includes TensorBoard-compatible logging, which allows the learning rate and training metrics to be monitored in real-time. By default, the training script logs metrics to the following TensorBoard log directory <code class="docutils literal notranslate"><span class="pre">~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain/output/neuron_tblogs_&lt;date/time&gt;_&lt;training</span> <span class="pre">configs&gt;</span></code>.</p> <p>In order to view your training metrics in TensorBoard, first run the following commands in your SSH session:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain tensorboard<span class="w"> </span>--logdir<span class="w"> </span>./output </pre></div> </div> <p>Once running, open a new SSH connection to the instance and port-forward TCP port 6006 (ex: <code class="docutils literal notranslate"><span class="pre">-L</span> <span class="pre">6006:127.0.0.1:6006</span></code>). Once the tunnel is established, TensorBoard can then be accessed via web browser at the following URL: <a class="reference external" href="http://localhost:6006/">http://localhost:6006</a>. Please note that you will not be able to access TensorBoard if you disconnect your port-forwarding SSH session to the Trainium instance.</p> <img alt="Image: tensorboard.png" src="../../../../../_images/tensorboard1.png"> </div> <div class="section" id="finishing-the-tutorial"> <h3><a class="toc-backref" href="#id13">Finishing the tutorial</a><a class="headerlink" href="#finishing-the-tutorial" title="Permalink to this headline">#</a></h3> <p>Once you are ready, there are a couple of options for finishing the BERT pretraining demo:</p> <ol class="arabic simple"> <li><p><strong>Allow the training script to run to completion</strong>. If you would like to observe the training script run to completion, it is recommended to launch the training script from a terminal multiplexer such as <code class="docutils literal notranslate"><span class="pre">tmux</span></code> or <code class="docutils literal notranslate"><span class="pre">screen</span></code>, and then detach the session so that the training script can run in the background. With this approach, you can safely let the training script run unattended, without risk of an SSH disconnection causing the training job to stop running.</p></li> <li><p><strong>Stop the training job early</strong>. To stop the training job early, press CTRL-C in the terminal window in which you launched the training script. In some cases, if you manually cancel a job using CTRL-C and then later want to run the job again, you might first need to execute <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">rmmod</span> <span class="pre">neuron;</span> <span class="pre">sudo</span> <span class="pre">modprobe</span> <span class="pre">neuron</span></code> in order to reload/reset the Neuron driver.</p></li> </ol> </div> </div> <div class="section" id="phase-1-bert-large-pretraining-with-layerwise-adaptive-moments-based-optimizer-lamb"> <h2><a class="toc-backref" href="#id14">Phase 1 BERT-Large pretraining with Layerwise Adaptive Moments based optimizer (LAMB)</a><a class="headerlink" href="#phase-1-bert-large-pretraining-with-layerwise-adaptive-moments-based-optimizer-lamb" title="Permalink to this headline">#</a></h2> <p>Sometimes, to reduce the training wall time, you can use higher learning rate and larger global batch size. The approach is discussed in <a class="reference external" href="https://arxiv.org/pdf/1904.00962.pdf">LARGE BATCH OPTIMIZATION FOR DEEP LEARNING: TRAINING BERT IN 76 MINUTES</a>. Tranium supports LAMB, and in this tutorial, we use publicly available XLA-friendly LAMB implemenation from <a class="reference external" href="https://github.com/rwightman/pytorch-image-models/blob/master/timm/optim/lamb.py">https://github.com/rwightman/pytorch-image-models/blob/master/timm/optim/lamb.py</a>.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span><span class="se">\</span> dp_bert_large_hf_pretrain_hdf5.py<span class="w"> </span><span class="se">\</span> --max_steps<span class="w"> </span><span class="m">7032</span><span class="w"> </span><span class="se">\</span> --batch_size<span class="w"> </span><span class="m">8</span><span class="w"> </span><span class="se">\</span> --optimizer<span class="w"> </span>LAMB<span class="w"> </span><span class="se">\</span> --lr<span class="w"> </span>6e-3<span class="w"> </span><span class="se">\</span> --grad_accum_usteps<span class="w"> </span><span class="m">256</span><span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>run_pretrain_log.txt </pre></div> </div> <p>The command-line argument <code class="docutils literal notranslate"><span class="pre">--optimizer</span> <span class="pre">LAMB</span></code> is needed, otherwise, the default optimizer AdamW will be used. Besides, you need to use a set of hyper-parameters supporting the larger global batch size (GBS). In this case, we have 64k as GBS for LAMB and use a set of hyper-params similar to <a class="reference external" href="https://github.com/NVIDIA/DeepLearningExamples/blob/master/PyTorch/LanguageModeling/BERT/README.md">https://github.com/NVIDIA/DeepLearningExamples/blob/master/PyTorch/LanguageModeling/BERT/README.md</a>. Given higher GBS from LAMB than AdamW, it takes fewer steps (roughly 7k) to achieve similar level of accuracy as AdamW, which takes more than 28k steps. In addition, you can also use different data types on top of LAMB. Below is an example using the BFloat16 and Stochastic Roundings.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain <span class="nv">XLA_DOWNCAST_BF16</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span><span class="se">\</span> dp_bert_large_hf_pretrain_hdf5.py<span class="w"> </span><span class="se">\</span> --max_steps<span class="w"> </span><span class="m">7032</span><span class="w"> </span><span class="se">\</span> --batch_size<span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="se">\</span> --optimizer<span class="w"> </span>LAMB<span class="w"> </span><span class="se">\</span> --lr<span class="w"> </span>6e-3<span class="w"> </span><span class="se">\</span> --grad_accum_usteps<span class="w"> </span><span class="m">128</span><span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>run_pretrain_log.txt </pre></div> </div> <p>The script <code class="docutils literal notranslate"><span class="pre">run_dp_bert_large_hf_pretrain_bf16_s128_lamb.sh</span></code> is provided in the same BERT tutorial directory for convenience and you can simply run the script to start the training.</p> </div> <div class="section" id="phase-1-bert-large-pretraining-with-pytorch-autocast-amp-and-stochastic-rounding"> <span id="amp-sr-phase1"></span><h2><a class="toc-backref" href="#id15">Phase 1 BERT-Large pretraining with PyTorch Autocast (AMP) and stochastic rounding</a><a class="headerlink" href="#phase-1-bert-large-pretraining-with-pytorch-autocast-amp-and-stochastic-rounding" title="Permalink to this headline">#</a></h2> <p>Besides the <a class="reference internal" href="#bf16-sr-phase1"><span class="std std-ref">BFloat16 and stochastic rounding in phase 1</span></a> , you can also use AMP with stochastic rounding. The detailed background is at <a class="reference external" href="https://pytorch.org/docs/stable/amp.html">https://pytorch.org/docs/stable/amp.html</a>. It uses both data types BFloat16 and Float32, hence provides better performance over Float32. A detailed comparison is available at <span class="xref std std-ref">trn1_training_perf</span>. To launch the AMP, one additional command-line argument is needed <code class="docutils literal notranslate"><span class="pre">--enable_pt_autocast</span></code>. <code class="docutils literal notranslate"><span class="pre">NEURON_RT_STOCHASTIC_ROUNDING_EN=1</span></code> enables the stochastic roundings.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain <span class="nv">NEURON_RT_STOCHASTIC_ROUNDING_EN</span><span class="o">=</span><span class="m">1</span><span class="w"> </span><span class="se">\</span> torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span>dp_bert_large_hf_pretrain_hdf5.py<span class="w"> </span><span class="se">\</span> --batch_size<span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="se">\</span> --enable_pt_autocast<span class="w"> </span><span class="se">\</span> --grad_accum_usteps<span class="w"> </span><span class="m">32</span><span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>run_pretrain_log.txt </pre></div> </div> <p>The script <code class="docutils literal notranslate"><span class="pre">run_dp_bert_large_hf_pretrain_bf16_s128.sh</span></code> is provided in the same BERT tutorial directory for convenience and you can simply run the script with <code class="docutils literal notranslate"><span class="pre">amp</span></code> option like <code class="docutils literal notranslate"><span class="pre">./run_dp_bert_large_hf_pretrain_bf16_s128.sh</span> <span class="pre">amp</span></code> to start the training with AMP.</p> </div> <div class="section" id="phase-1-bert-large-pretraining-on-two-instances"> <h2><a class="toc-backref" href="#id16">Phase 1 BERT-Large pretraining on two instances</a><a class="headerlink" href="#phase-1-bert-large-pretraining-on-two-instances" title="Permalink to this headline">#</a></h2> <p>If you have two trn1.32xlarge instances with EFA-enabled interfaces, using <a class="reference external" href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa-start-nccl-base.html#nccl-start-base-setup">EFA-enabled security group</a>, and setup using <a class="reference internal" href="../../setup/pytorch-install.html#pytorch-neuronx-install"><span class="std std-ref">Install PyTorch Neuron on Trn1</span></a>, you can run multi-instance BERT-Large pretraining. The following example demonstrate running BERT phase 1 pretraining on two instances. To ensure that the global batch size remains at 16384 for phase 1, the gradient accumulation microstep count is reduced by half when the number of instances is 2. NOTE: To run on multiple instances, you will need to use trn1.32xlarge instances and using all 32 NeuronCores on each instance.</p> <p>On the rank-0 Trn1 host (root), run with <code class="docutils literal notranslate"><span class="pre">--node_rank=0</span></code> using torchrun utility, and <code class="docutils literal notranslate"><span class="pre">--master_addr</span></code> set to rank-0 host’s IP address:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain <span class="nb">export</span><span class="w"> </span><span class="nv">FI_EFA_USE_DEVICE_RDMA</span><span class="o">=</span><span class="m">1</span> <span class="nb">export</span><span class="w"> </span><span class="nv">FI_PROVIDER</span><span class="o">=</span>efa <span class="nb">export</span><span class="w"> </span><span class="nv">BUCKET_CAP_MB</span><span class="o">=</span><span class="m">512</span> <span class="nb">export</span><span class="w"> </span><span class="nv">XLA_TRANSFER_SEED_ASYNC</span><span class="o">=</span><span class="m">1</span> <span class="nv">XLA_DOWNCAST_BF16</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span>--nnodes<span class="o">=</span><span class="m">2</span><span class="w"> </span>--node_rank<span class="o">=</span><span class="m">0</span><span class="w"> </span>--master_addr<span class="o">=</span>&lt;root<span class="w"> </span>IP&gt;<span class="w"> </span>--master_port<span class="o">=</span><span class="m">2020</span><span class="w"> </span><span class="se">\</span> dp_bert_large_hf_pretrain_hdf5.py<span class="w"> </span><span class="se">\</span> --batch_size<span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="se">\</span> --grad_accum_usteps<span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>run_pretrain_log.txt </pre></div> </div> <p>On another Trn1 host, run with <code class="docutils literal notranslate"><span class="pre">--node_rank=1</span></code>, and <code class="docutils literal notranslate"><span class="pre">--master_addr</span></code> also set to rank-0 host’s IP address:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain <span class="nb">export</span><span class="w"> </span><span class="nv">FI_EFA_USE_DEVICE_RDMA</span><span class="o">=</span><span class="m">1</span> <span class="nb">export</span><span class="w"> </span><span class="nv">FI_PROVIDER</span><span class="o">=</span>efa <span class="nb">export</span><span class="w"> </span><span class="nv">BUCKET_CAP_MB</span><span class="o">=</span><span class="m">512</span> <span class="nb">export</span><span class="w"> </span><span class="nv">XLA_TRANSFER_SEED_ASYNC</span><span class="o">=</span><span class="m">1</span> <span class="nv">XLA_DOWNCAST_BF16</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span>--nnodes<span class="o">=</span><span class="m">2</span><span class="w"> </span>--node_rank<span class="o">=</span><span class="m">1</span><span class="w"> </span>--master_addr<span class="o">=</span>&lt;root<span class="w"> </span>IP&gt;<span class="w"> </span>--master_port<span class="o">=</span><span class="m">2020</span><span class="w"> </span><span class="se">\</span> dp_bert_large_hf_pretrain_hdf5.py<span class="w"> </span><span class="se">\</span> --batch_size<span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="se">\</span> --grad_accum_usteps<span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>run_pretrain_log.txt </pre></div> </div> <p>It is important to launch rank-0 worker with <code class="docutils literal notranslate"><span class="pre">--node_rank=0</span></code> to avoid hang.</p> <p>To train on multiple instances, it is recommended to use a ParallelCluster. For a ParallelCluster example, please see <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples">Train a model on AWS Trn1 ParallelCluster</a>.</p> </div> <div class="section" id="phase-2-bert-large-pretraining"> <h2><a class="toc-backref" href="#id17">Phase 2 BERT-Large pretraining</a><a class="headerlink" href="#phase-2-bert-large-pretraining" title="Permalink to this headline">#</a></h2> <p>As mentioned above, BERT pretraining happens in two phases. In phase 1, the sequence length is 128. In phase 2, the sequence length increases to 512. This additional training phase will further reduce the pretraining loss and improve the metrics for the fine-tune tasks that usually follow. The setup is very similar to the phase 1, with some differences in training environment and command line arguments highlighted below.</p> <div class="section" id="training-environment"> <h3><a class="toc-backref" href="#id18">Training Environment</a><a class="headerlink" href="#training-environment" title="Permalink to this headline">#</a></h3> <p>The following dataset and checkpoint are required:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512</span></code> is WikiCorpus training dataset that is preprocessed (tokenized and pre-masked) for phase 2.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">~/examples/dp_bert_hf_pretrain/output/ckpt_&lt;phase1_end_step&gt;.pt</span></code> is the final checkpoint from phase 1. It’s generated automatically at the end of phase 1 pretraining. For convenience, one can also download the example available at <code class="docutils literal notranslate"><span class="pre">s3://neuron-s3/training_checkpoints/pytorch/dp_bert_large_hf_pretrain/ckpt_28125.pt</span></code>, which is collected after 28125 training steps in phase 1. Phase 2 will continue training by loading this checkpoint. During its progression, phase 2 continues to generate its own checkpoints in output directory, following the naming convention <code class="docutils literal notranslate"><span class="pre">ckpt_&lt;global_steps&gt;.pt</span></code></p></li> </ul> </div> <div class="section" id="id1"> <h3><a class="toc-backref" href="#id19">Initiating a Training Job</a><a class="headerlink" href="#id1" title="Permalink to this headline">#</a></h3> <p>To launch the phase 2 pretraining job with AdamW optimizer, run the same python script <code class="docutils literal notranslate"><span class="pre">dp_bert_large_hf_pretrain_hdf5.py</span></code> as before except with different options for phase 2. Again, we are using BFloat16 casting and stochastic rounding by setting environment variable <code class="docutils literal notranslate"><span class="pre">XLA_DOWNCAST_BF16=1</span></code>. For phase 2, we are using global batch size of 32768, with worker device batch size of 2 and gradient accumulation microsteps of 512. The pretokenized dataset is expected to be at <code class="docutils literal notranslate"><span class="pre">~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512/</span></code> following the setup steps above and is set via <code class="docutils literal notranslate"><span class="pre">--data_dir</span></code> option.</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/aws-neuron-samples/torch-neuronx/training/dp_bert_hf_pretrain <span class="nv">XLA_DOWNCAST_BF16</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span>dp_bert_large_hf_pretrain_hdf5.py<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--data_dir<span class="w"> </span>~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512/<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--lr<span class="w"> </span><span class="m">2</span>.8e-4<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--phase2<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--resume_ckpt<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--phase1_end_step<span class="w"> </span><span class="m">28125</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>--batch_size<span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>--grad_accum_usteps<span class="w"> </span><span class="m">512</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>--seq_len<span class="w"> </span><span class="m">512</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>--max_pred_len<span class="w"> </span><span class="m">80</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>--warmup_steps<span class="w"> </span><span class="m">781</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span>--max_steps<span class="w"> </span><span class="m">1563</span><span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>run_pretrain_log_phase2.txt </pre></div> </div> <p>The script <code class="docutils literal notranslate"><span class="pre">run_dp_bert_large_hf_pretrain_bf16_s128.sh</span></code> is provided in the same BERT tutorial directory for convenience and you can simply run the script to start the training with AdamW optimizer. Similarly, you can use LAMB optimizer using the script <code class="docutils literal notranslate"><span class="pre">run_dp_bert_large_hf_pretrain_bf16_s512_lamb_phase2.sh</span></code>.</p> <p>The output below is expected as the job is initiated. Step 28125 is the phase1_end_step in this run, which could be different if phase1 training stops at a different global step.</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>Worker<span class="w"> </span><span class="m">21</span><span class="w"> </span>resuming<span class="w"> </span>from<span class="w"> </span>checkpoint<span class="w"> </span>./output/ckpt_28125.pt<span class="w"> </span>at<span class="w"> </span>step<span class="w"> </span><span class="m">28125</span> Worker<span class="w"> </span><span class="m">23</span><span class="w"> </span>resuming<span class="w"> </span>from<span class="w"> </span>checkpoint<span class="w"> </span>./output/ckpt_28125.pt<span class="w"> </span>at<span class="w"> </span>step<span class="w"> </span><span class="m">28125</span> Worker<span class="w"> </span><span class="m">27</span><span class="w"> </span>resuming<span class="w"> </span>from<span class="w"> </span>checkpoint<span class="w"> </span>./output/ckpt_28125.pt<span class="w"> </span>at<span class="w"> </span>step<span class="w"> </span><span class="m">28125</span> Worker<span class="w"> </span><span class="m">26</span><span class="w"> </span>resuming<span class="w"> </span>from<span class="w"> </span>checkpoint<span class="w"> </span>./output/ckpt_28125.pt<span class="w"> </span>at<span class="w"> </span>step<span class="w"> </span><span class="m">28125</span> Worker<span class="w"> </span><span class="m">20</span><span class="w"> </span>resuming<span class="w"> </span>from<span class="w"> </span>checkpoint<span class="w"> </span>./output/ckpt_28125.pt<span class="w"> </span>at<span class="w"> </span>step<span class="w"> </span><span class="m">28125</span> Worker<span class="w"> </span><span class="m">22</span><span class="w"> </span>resuming<span class="w"> </span>from<span class="w"> </span>checkpoint<span class="w"> </span>./output/ckpt_28125.pt<span class="w"> </span>at<span class="w"> </span>step<span class="w"> </span><span class="m">28125</span> --------TRAINING<span class="w"> </span>CONFIG---------- Namespace<span class="o">(</span><span class="nv">batch_size</span><span class="o">=</span><span class="m">2</span>,<span class="w"> </span><span class="nv">data_dir</span><span class="o">=</span><span class="s1">'/home/ec2-user/examples_datasets/</span> <span class="s1">bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512/'</span>,<span class="w"> </span><span class="nv">debug</span><span class="o">=</span>False, <span class="nv">enable_pt_autocast</span><span class="o">=</span>False,<span class="w"> </span><span class="nv">grad_accum_usteps</span><span class="o">=</span><span class="m">512</span>,<span class="w"> </span><span class="nv">local_rank</span><span class="o">=</span><span class="m">0</span>,<span class="w"> </span><span class="nv">lr</span><span class="o">=</span><span class="m">0</span>.0002, <span class="nv">max_pred_len</span><span class="o">=</span><span class="m">80</span>,<span class="w"> </span><span class="nv">max_steps</span><span class="o">=</span><span class="m">28125</span>,<span class="w"> </span><span class="nv">metrics_file</span><span class="o">=</span><span class="s1">'/tmp/test_dict.json'</span>, <span class="nv">minimal_ckpt</span><span class="o">=</span>False,<span class="w"> </span><span class="nv">num_ckpts_to_keep</span><span class="o">=</span><span class="m">1</span>,<span class="w"> </span><span class="nv">output_dir</span><span class="o">=</span><span class="s1">'./output'</span>, <span class="nv">phase1_end_step</span><span class="o">=</span><span class="m">28125</span>,<span class="w"> </span><span class="nv">phase2</span><span class="o">=</span>True,<span class="w"> </span><span class="nv">resume_ckpt</span><span class="o">=</span>True,<span class="w"> </span><span class="nv">resume_step</span><span class="o">=</span>-1, <span class="nv">seed</span><span class="o">=</span><span class="m">12349</span>,<span class="w"> </span><span class="nv">seq_len</span><span class="o">=</span><span class="m">512</span>,<span class="w"> </span><span class="nv">shards_per_ckpt</span><span class="o">=</span><span class="m">1</span>,<span class="w"> </span><span class="nv">steps_this_run</span><span class="o">=</span><span class="m">32</span>,<span class="w"> </span><span class="nv">warmup_steps</span><span class="o">=</span><span class="m">781</span><span class="o">)</span> --------MODEL<span class="w"> </span>CONFIG---------- BertConfig<span class="w"> </span><span class="o">{</span> <span class="w"> </span><span class="s2">"_name_or_path"</span>:<span class="w"> </span><span class="s2">"bert-large-uncased"</span>, <span class="w"> </span><span class="s2">"architectures"</span>:<span class="w"> </span><span class="o">[</span> <span class="w"> </span><span class="s2">"BertForMaskedLM"</span> <span class="w"> </span><span class="o">]</span>, <span class="w"> </span><span class="s2">"attention_probs_dropout_prob"</span>:<span class="w"> </span><span class="m">0</span>.1, <span class="w"> </span><span class="s2">"classifier_dropout"</span>:<span class="w"> </span>null, <span class="w"> </span><span class="s2">"gradient_checkpointing"</span>:<span class="w"> </span>false, <span class="w"> </span><span class="s2">"hidden_act"</span>:<span class="w"> </span><span class="s2">"gelu"</span>, <span class="w"> </span><span class="s2">"hidden_dropout_prob"</span>:<span class="w"> </span><span class="m">0</span>.1, <span class="w"> </span><span class="s2">"hidden_size"</span>:<span class="w"> </span><span class="m">1024</span>, <span class="w"> </span><span class="s2">"initializer_range"</span>:<span class="w"> </span><span class="m">0</span>.02, <span class="w"> </span><span class="s2">"intermediate_size"</span>:<span class="w"> </span><span class="m">4096</span>, <span class="w"> </span><span class="s2">"layer_norm_eps"</span>:<span class="w"> </span>1e-12, <span class="w"> </span><span class="s2">"max_position_embeddings"</span>:<span class="w"> </span><span class="m">512</span>, <span class="w"> </span><span class="s2">"model_type"</span>:<span class="w"> </span><span class="s2">"bert"</span>, <span class="w"> </span><span class="s2">"num_attention_heads"</span>:<span class="w"> </span><span class="m">16</span>, <span class="w"> </span><span class="s2">"num_hidden_layers"</span>:<span class="w"> </span><span class="m">24</span>, <span class="w"> </span><span class="s2">"pad_token_id"</span>:<span class="w"> </span><span class="m">0</span>, <span class="w"> </span><span class="s2">"position_embedding_type"</span>:<span class="w"> </span><span class="s2">"absolute"</span>, <span class="w"> </span><span class="s2">"transformers_version"</span>:<span class="w"> </span><span class="s2">"4.15.0"</span>, <span class="w"> </span><span class="s2">"type_vocab_size"</span>:<span class="w"> </span><span class="m">2</span>, <span class="w"> </span><span class="s2">"use_cache"</span>:<span class="w"> </span>true, <span class="w"> </span><span class="s2">"vocab_size"</span>:<span class="w"> </span><span class="m">30522</span> <span class="o">}</span> </pre></div> </div> <p>As the phase 2 training proceeds, similar metrics to phase 1 will appear on the console, showing the loss, learning rate, and throughput:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>LOG<span class="w"> </span>Tue<span class="w"> </span>Sep<span class="w"> </span><span class="m">27</span><span class="w"> </span><span class="m">20</span>:56:35<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">26</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">4</span>.3438<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">6</span>.66e-06<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">494</span>.55 LOG<span class="w"> </span>Tue<span class="w"> </span>Sep<span class="w"> </span><span class="m">27</span><span class="w"> </span><span class="m">20</span>:57:40<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">27</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">4</span>.0938<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">6</span>.91e-06<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">495</span>.67 LOG<span class="w"> </span>Tue<span class="w"> </span>Sep<span class="w"> </span><span class="m">27</span><span class="w"> </span><span class="m">20</span>:58:46<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">28</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">4</span>.1875<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">7</span>.17e-06<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">496</span>.18 LOG<span class="w"> </span>Tue<span class="w"> </span>Sep<span class="w"> </span><span class="m">27</span><span class="w"> </span><span class="m">20</span>:59:53<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">29</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">4</span>.0000<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">7</span>.43e-06<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">495</span>.31 LOG<span class="w"> </span>Tue<span class="w"> </span>Sep<span class="w"> </span><span class="m">27</span><span class="w"> </span><span class="m">21</span>:00:58<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">30</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">4</span>.2500<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">7</span>.68e-06<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">495</span>.60 LOG<span class="w"> </span>Tue<span class="w"> </span>Sep<span class="w"> </span><span class="m">27</span><span class="w"> </span><span class="m">21</span>:02:05<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">31</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">4</span>.3125<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">7</span>.94e-06<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">495</span>.50 LOG<span class="w"> </span>Tue<span class="w"> </span>Sep<span class="w"> </span><span class="m">27</span><span class="w"> </span><span class="m">21</span>:03:10<span class="w"> </span><span class="m">2022</span><span class="w"> </span>-<span class="w"> </span><span class="o">(</span><span class="m">0</span>,<span class="w"> </span><span class="m">32</span><span class="o">)</span><span class="w"> </span>step_loss<span class="w"> </span>:<span class="w"> </span><span class="m">4</span>.4688<span class="w"> </span>learning_rate<span class="w"> </span>:<span class="w"> </span><span class="m">8</span>.19e-06<span class="w"> </span>throughput<span class="w"> </span>:<span class="w"> </span><span class="m">496</span>.02 </pre></div> </div> </div> </div> <div class="section" id="tools"> <h2><a class="toc-backref" href="#id20">Tools</a><a class="headerlink" href="#tools" title="Permalink to this headline">#</a></h2> <p>While running the tutorial, try experimenting with the following Neuron tools, which help monitor and evaluate compute utilization in real-time:</p> <div class="section" id="neuron-ls"> <h3><a class="toc-backref" href="#id21">neuron-ls</a><a class="headerlink" href="#neuron-ls" title="Permalink to this headline">#</a></h3> <p>The <code class="docutils literal notranslate"><span class="pre">neuron-ls</span></code> command describes the number of Neuron devices present in the system, along with the associated NeuronCore count, memory, and PCI device information:</p> <img alt="Image: image.png" src="../../../../../_images/neuron-ls.png"> <p>You will find that the Trn1 instance has 16 Neuron devices, each with 2 NeuronCores. This configuration allows you to train the model using a total of 32 workers, one per NeuronCore, within a single instance.</p> <p>Additional information regarding neuron-ls can be found in the <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/neuron-guide/neuron-tools/neuron-ls.html">neuron-ls user guide</a>.</p> </div> <div class="section" id="neuron-top"> <h3><a class="toc-backref" href="#id22">neuron-top</a><a class="headerlink" href="#neuron-top" title="Permalink to this headline">#</a></h3> <p>The <code class="docutils literal notranslate"><span class="pre">neuron-top</span></code> command presents a high-level view of the Neuron environment, including the utilization of each of the NeuronCores, any models that are currently loaded onto one or more NeuronCores, process IDs for any processes that are leveraging the Neuron runtime, and basic system statistics relating to vCPU and memory usage.</p> <p>Please note that <code class="docutils literal notranslate"><span class="pre">neuron-top</span></code> can either display aggregate NeuronCore utilization for ‘all’ processes (the default), or alternatively display the NeuronCore utilization for a particular process. You can toggle through the aggregate and per-process views using the <code class="docutils literal notranslate"><span class="pre">a</span></code> and <code class="docutils literal notranslate"><span class="pre">d</span></code> keys. The screenshot below illustrates the default aggregate view:</p> <img alt="Image: image.png" src="../../../../../_images/neuron-top.png"> <p>Please refer to the <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/neuron-guide/neuron-tools/neuron-top-user-guide.html">neuron-top user guide</a> for additional details.</p> </div> <div class="section" id="generating-tokenized-and-sharded-dataset-files"> <h3><a class="toc-backref" href="#id23">Generating tokenized and sharded dataset files</a><a class="headerlink" href="#generating-tokenized-and-sharded-dataset-files" title="Permalink to this headline">#</a></h3> <p>This section is for generating tokenized and sharded dataset files from WikiCorpus dataset. If you just want the pregenenerated dataset files, please see <code class="docutils literal notranslate"><span class="pre">Downloading</span> <span class="pre">tokenized</span> <span class="pre">and</span> <span class="pre">sharded</span> <span class="pre">dataset</span> <span class="pre">files</span></code> section above.</p> <p>On a c5n.18xlarge instance launched with Deep Learning Conda AMI and 512GB disk space, you can generate the preprocessed datasets from WikiCorpus dataset using NVidia’s DeepLearningExamples for BERT pretraining. The preprocessing converts the WikiCorpus dataset to tokenized data and shard the data into multiple shards for parallel loading. The full flow takes about 8.7 hours:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>activate<span class="w"> </span>pytorch_latest_p37 <span class="nb">cd</span><span class="w"> </span>~/ git<span class="w"> </span>clone<span class="w"> </span>https://github.com/NVIDIA/DeepLearningExamples.git <span class="nb">cd</span><span class="w"> </span>DeepLearningExamples git<span class="w"> </span>checkout<span class="w"> </span>81b9010096b6f9812e3977b607669f6ec8b16561 sudo<span class="w"> </span>mkdir<span class="w"> </span>-m<span class="w"> </span><span class="nv">a</span><span class="o">=</span>rwx<span class="w"> </span>/workspace cp<span class="w"> </span>-rf<span class="w"> </span>PyTorch/LanguageModeling/BERT<span class="w"> </span>/workspace/bert <span class="nb">cd</span><span class="w"> </span>/workspace git<span class="w"> </span>clone<span class="w"> </span>https://github.com/attardi/wikiextractor.git <span class="nb">cd</span><span class="w"> </span>wikiextractor git<span class="w"> </span>checkout<span class="w"> </span>6408a430fc504a38b04d37ce5e7fc740191dee16 <span class="nb">cd</span><span class="w"> </span>/workspace/bert <span class="c1"># increase num processes and shards</span> ex<span class="w"> </span>-s<span class="w"> </span><span class="s2">"+%s/\(bertPrep\.py\)\( --action create_hdf5_files\)/\1 --n_processes 32 --n_test_shards 1024 --n_training_shards 1024\2"</span><span class="w"> </span><span class="s2">"+wq"</span><span class="w"> </span>data/create_datasets_from_start.sh <span class="nb">export</span><span class="w"> </span><span class="nv">BERT_PREP_WORKING_DIR</span><span class="o">=</span>/workspace/data/ <span class="nb">time</span><span class="w"> </span>./data/create_datasets_from_start.sh<span class="w"> </span>wiki_only<span class="w"> </span><span class="p">|&amp;</span><span class="w"> </span>tee<span class="w"> </span>log </pre></div> </div> <p>After execution is finished, phase 1 pre-tokenized and sharded dataset is located at:</p> <p><code class="docutils literal notranslate"><span class="pre">/workspace/data/hdf5_lower_case_1_seq_len_128_max_pred_20_masked_lm_prob_0.15_random_seed_12345_dupe_factor_5/wikicorpus_en/</span></code></p> <p>Copy this entire directory to <code class="docutils literal notranslate"><span class="pre">~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen128</span></code> of the trn1.32xlarge machine.</p> <p>Phase 2 pre-tokenized dataset is located at:</p> <p><code class="docutils literal notranslate"><span class="pre">/workspace/data/hdf5_lower_case_1_seq_len_512_max_pred_80_masked_lm_prob_0.15_random_seed_12345_dupe_factor_5/wikicorpus_en/</span></code></p> <p>Copy this entire directory to <code class="docutils literal notranslate"><span class="pre">~/examples_datasets/bert_pretrain_wikicorpus_tokenized_hdf5_seqlen512</span></code> of the trn1.32xlarge machine.</p> </div> </div> <div class="section" id="known-issues-and-limitations"> <h2><a class="toc-backref" href="#id24">Known issues and limitations</a><a class="headerlink" href="#known-issues-and-limitations" title="Permalink to this headline">#</a></h2> <div class="section" id="nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> <h3><a class="toc-backref" href="#id25">NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1</a><a class="headerlink" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1" title="Permalink to this headline">#</a></h3> <p>When running HuggingFace BERT (any size) fine-tuning tutorial or pretraining tutorial with transformers version &gt;= 4.21.0 and using XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1, you will see NaNs in the loss immediately at the first step. More details on the issue can be found at <a class="reference external" href="https://github.com/pytorch/xla/issues/4152">pytorch/xla#4152</a>. The workaround is to use 4.20.0 or earlier (the tutorials currently recommend version 4.15.0) or add <code class="docutils literal notranslate"><span class="pre">transformers.modeling_utils.get_parameter_dtype</span> <span class="pre">=</span> <span class="pre">lambda</span> <span class="pre">x:</span> <span class="pre">torch.bfloat16</span></code> to the Python script.</p> </div> <div class="section" id="bert-large-compilation-limitations"> <h3><a class="toc-backref" href="#id26">BERT-large compilation limitations</a><a class="headerlink" href="#bert-large-compilation-limitations" title="Permalink to this headline">#</a></h3> <p>Optimal BERT-large phase 1 (sequence length 128) batch size is currently 8 for FP32 and 16 for full BF16 with stochastic rounding. Optimal BERT-large phase 2 (sequence length 512) batch size is currently 1 for FP32 and 2 for full BF16 with stochastic rounding.</p> </div> <div class="section" id="bert-large-pretraining-with-pretokenized-dataset-hangs-when-using-xm-save"> <h3><a class="toc-backref" href="#id27">BERT-large pretraining with pretokenized dataset hangs when using xm.save</a><a class="headerlink" href="#bert-large-pretraining-with-pretokenized-dataset-hangs-when-using-xm-save" title="Permalink to this headline">#</a></h3> <p>Currently, BERT-large pretraining with pretokenized dataset hangs when <code class="docutils literal notranslate"><span class="pre">xm.save</span></code> is used outside of the main training loop.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">Loop</span> <span class="n">through</span> <span class="n">HDF5</span> <span class="n">sharded</span> <span class="n">dataset</span> <span class="n">files</span><span class="p">:</span> <span class="n">Train</span> <span class="n">on</span> <span class="n">one</span> <span class="n">HDF5</span> <span class="n">sharded</span> <span class="n">dataset</span> <span class="n">file</span> <span class="n">Loop</span> <span class="n">through</span> <span class="n">batched</span> <span class="n">samples</span><span class="p">:</span> <span class="n">Training</span> <span class="n">iteration</span> <span class="n">Save</span> <span class="n">checkpoint</span> <span class="n">using</span> <span class="n">xm</span><span class="o">.</span><span class="n">save</span> </pre></div> </div> <p>The reason is that xm.save has a synchronization point. However, the HDF5 shared data files do not have the same number of training samples so the workers cannot all reach xm.save in the same iteration.</p> <p>The workaround is to use <code class="docutils literal notranslate"><span class="pre">xm._maybe_convert_to_cpu</span></code> to ensure tensors are moved to CPU followed by <code class="docutils literal notranslate"><span class="pre">torch.save</span></code> as done in the BERT-large pretraining tutorial:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">cpu_data</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">_maybe_convert_to_cpu</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="bert-large-two-worker-pretraining-hangs-or-run-out-of-host-memory-during-checkpointing-on-trn1-2xlarge"> <h3><a class="toc-backref" href="#id28">BERT-large two worker pretraining hangs or run out of host memory during checkpointing on trn1.2xlarge</a><a class="headerlink" href="#bert-large-two-worker-pretraining-hangs-or-run-out-of-host-memory-during-checkpointing-on-trn1-2xlarge" title="Permalink to this headline">#</a></h3> <p>On trn1.2xlarge, where there’s limited host memory and CPU resources, the BERT-large two worker pretraining may hang or run out of host memory during checkpointing. This problem can be worked around by not saving optimizer and LR scheduler states in the checkpoint. This is enabled by <code class="xref std std-option docutils literal notranslate"><span class="pre">--minimal_ckpt</span></code> option of the pretraining script.</p> </div> <div class="section" id="bert-precompilation-using-neuron-parallel-compile-hangs-when-using-torchrun"> <h3><a class="toc-backref" href="#id29">BERT precompilation using neuron_parallel_compile hangs when using torchrun</a><a class="headerlink" href="#bert-precompilation-using-neuron-parallel-compile-hangs-when-using-torchrun" title="Permalink to this headline">#</a></h3> <p>We use neuron_parallel_compile in front of the short run command to do precompilation. However, the following command hangs when running BERT parallel compilation with torchrun:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>neuron_parallel_compile<span class="w"> </span><span class="nv">XLA_DOWNCAST_BF16</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span>--nnodes<span class="o">=</span><span class="m">1</span><span class="w"> </span>dp_bert_large_hf_pretrain_hdf5.py<span class="w"> </span>--steps_this_run<span class="w"> </span><span class="m">5</span> ... Updating<span class="w"> </span>train<span class="w"> </span>metrics<span class="w"> </span><span class="k">in</span><span class="w"> </span>provide<span class="w"> </span>results.json<span class="w"> </span>file Current<span class="w"> </span>data:<span class="w"> </span><span class="o">{</span><span class="s1">'num_workers'</span>:<span class="w"> </span><span class="m">32</span>,<span class="w"> </span><span class="s1">'epoch'</span>:<span class="w"> </span><span class="m">0</span>,<span class="w"> </span><span class="s1">'steps'</span>:<span class="w"> </span><span class="m">5</span>,<span class="w"> </span><span class="s1">'microsteps'</span>:<span class="w"> </span><span class="m">320</span>,<span class="w"> </span><span class="s1">'loss'</span>:<span class="w"> </span>-22172234.0,<span class="w"> </span><span class="s1">'train_time_minutes'</span>:<span class="w"> </span><span class="m">0</span>.7424166639645894,<span class="w"> </span><span class="s1">'throughput_average'</span>:<span class="w"> </span><span class="m">1839</span>.0391805624324,<span class="w"> </span><span class="s1">'throughput_peak'</span>:<span class="w"> </span><span class="m">1840</span>.0107059878164,<span class="w"> </span><span class="s1">'batch_size'</span>:<span class="w"> </span><span class="m">8</span>,<span class="w"> </span><span class="s1">'max_length'</span>:<span class="w"> </span><span class="m">128</span><span class="o">}</span> Updating<span class="w"> </span>with<span class="w"> </span>data:<span class="w"> </span><span class="o">{</span><span class="s1">'num_workers'</span>:<span class="w"> </span><span class="m">32</span>,<span class="w"> </span><span class="s1">'epoch'</span>:<span class="w"> </span><span class="m">0</span>,<span class="w"> </span><span class="s1">'steps'</span>:<span class="w"> </span><span class="m">5</span>,<span class="w"> </span><span class="s1">'microsteps'</span>:<span class="w"> </span><span class="m">320</span>,<span class="w"> </span><span class="s1">'loss'</span>:<span class="w"> </span>-22172234.0,<span class="w"> </span><span class="s1">'train_time_minutes'</span>:<span class="w"> </span><span class="m">0</span>.7826640844345093,<span class="w"> </span><span class="s1">'throughput_average'</span>:<span class="w"> </span><span class="m">1744</span>.4691285659471,<span class="w"> </span><span class="s1">'throughput_peak'</span>:<span class="w"> </span><span class="m">1745</span>.4964663587539,<span class="w"> </span><span class="s1">'batch_size'</span>:<span class="w"> </span><span class="m">8</span>,<span class="w"> </span><span class="s1">'max_length'</span>:<span class="w"> </span><span class="m">128</span><span class="o">}</span> Checkpointing... Checkpointing<span class="w"> </span><span class="k">done</span>... <span class="o">(</span>hangs<span class="o">)</span> </pre></div> </div> <p>The fix is to add xm.rendezvous at the end of training to ensure all workers sync up before exiting the script dp_bert_large_pretrain_hdf5.py.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">_mp_fn</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">flags</span><span class="p">):</span> <span class="n">torch</span><span class="o">.</span><span class="n">set_default_tensor_type</span><span class="p">(</span><span class="s1">'torch.FloatTensor'</span><span class="p">)</span> <span class="n">train_bert_hdf5</span><span class="p">(</span><span class="n">flags</span><span class="p">)</span> <span class="n">xm</span><span class="o">.</span><span class="n">rendezvous</span><span class="p">(</span><span class="s2">"_mp_fn finished"</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="reduced-multi-node-performance-with-neuron-pytorch-1-12-release-2-6"> <h3><a class="toc-backref" href="#id30">Reduced multi-node performance with Neuron PyTorch 1.12 (release 2.6)</a><a class="headerlink" href="#reduced-multi-node-performance-with-neuron-pytorch-1-12-release-2-6" title="Permalink to this headline">#</a></h3> <p>Default BERT performance on multiple instances is reduced with Neuron PyTorch 1.12 (release 2.6). The workaround is to set the XLA flag XLA_TRANSFER_SEED_ASYNC=1.</p> </div> </div> <div class="section" id="troubleshooting"> <h2><a class="toc-backref" href="#id31">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline">#</a></h2> <p>The following are troubleshooting tips related to this tutorial. See <a class="reference internal" href="../../training-troubleshooting.html#pytorch-neuron-traning-troubleshooting"><span class="std std-ref">PyTorch Neuron on Trainium Troubleshooting Guide</span></a> for additional troubleshooting tips.</p> <div class="section" id="modulenotfounderror-no-module-named-torch-torch-xla-transformers-etc"> <span id="id2"></span><h3><a class="toc-backref" href="#id32">ModuleNotFoundError: No module named ‘torch’ , ‘torch_xla’, ‘transformers’, etc</a><a class="headerlink" href="#modulenotfounderror-no-module-named-torch-torch-xla-transformers-etc" title="Permalink to this headline">#</a></h3> <p>If you encounter ‘ModuleNotFoundError’ messages while attempting to run the demo scripts, please ensure that you have activated the appropriate Python <em>virtualenv</em> which contains all of the demo dependencies:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~ <span class="nb">source</span><span class="w"> </span>&lt;python<span class="w"> </span>virtual<span class="w"> </span>environment<span class="w"> </span>path&gt;/bin/activate </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tutorials-training-torch-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Tutorials for Training(torch-neuronx)</p> </div> </a> <a class="right-next" id="next-link" href="mlp.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Multi-Layer Perceptron Training Tutorial</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:05.444Z
Fine-tune T5 model on Trn1 — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html
# Fine-tune T5 model on Trn1 — AWS Neuron Documentation _This document is relevant for_: `Trn1`, `Trn1n` ## Fine-tune T5 model on Trn1[#](#fine-tune-t5-model-on-trn1 "Permalink to this headline") In this tutorial, we show how to fine-tune a Hugging Face (HF) T5 model using HF trainer API. This example fine-tunes a [T5 model for a text-summarization](https://github.com/huggingface/transformers/tree/master/examples/pytorch/summarization) task on CNN/DailyMail dataset. Table of Contents - [Setup and compilation](#setup-and-compilation) - [Single-worker training](#single-worker-training) - [Multi-worker Training](#multi-worker-training) - [Known issues and limitations](#known-issues-and-limitations) Note Logs used in tutorials do not present latest performance numbers For latest performance numbers visit [Neuron Performance](../../../../../general/benchmarks/index.html#benchmark) ## [Setup and compilation](#id2)[#](#setup-and-compilation "Permalink to this headline") Before running the tutorial please follow the installation instructions at: [Install PyTorch Neuron on Trn1](../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx) Please set the storage of instance to _512GB_ or more if you also want to run through the BERT pretraining and GPT pretraining tutorials. For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands: ``` source ~/aws_neuron_venv_pytorch/bin/activate ``` First we install a recent version of HF transformers, scikit-learn and evaluate packages in our environment as well as download the source matching the installed version. In this example, we chose version 4.26.0 and the text summarization example from HF transformers source: ``` export HF_VER=4.26.0 pip install -U transformers==$HF_VER datasets evaluate scikit-learn rouge_score pandas==1.4.0 cd ~/ git clone https://github.com/huggingface/transformers --branch v$HF_VER cd ~/transformers/examples/pytorch/summarization ``` ## [Single-worker training](#id3)[#](#single-worker-training "Permalink to this headline") We will run text-summarization fine-tuning task following the example in README.md located in the path ~/transformers/examples/pytorch/summarization. We use full BF16 casting using XLA\_USE\_BF16=1 to enable best performance. First, paste the following script into your terminal to create a “run.sh” file and change it to executable: ``` tee run.sh > /dev/null <<EOF #!/bin/bash if [ \$NEURON_PARALLEL_COMPILE == "1" ] then XLA_USE_BF16=1 python3 ./run_summarization.py \ --model_name_or_path t5-small \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 32 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --max_steps 100 \ --max_eval_samples 100 \ --gradient_accumulation_steps=32 \ --output_dir /tmp/tst-summarization |& tee log_run else XLA_USE_BF16=1 python3 ./run_summarization.py \ --model_name_or_path t5-small \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 32 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --gradient_accumulation_steps=32 \ --output_dir /tmp/tst-summarization |& tee log_run fi EOF chmod +x run.sh ``` We optionally precompile the model and training script using [neuron\_parallel\_compile](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html?highlight=neuron_parallel_compile) to warm up the persistent graph cache (Neuron Cache) such that the actual run has fewer compilations (faster run time): ``` neuron_parallel_compile ./run.sh ``` Note: For these auto-regressive models, do not run the `predict_with_generate` method when doing the precompile step. This is because the `neuron_parallel_compile` utility will run the training script in graph extraction mode and no actual execution of the graph will be done. Hence, the outputs at each step are invalid. Since the auto-regressive generation at each step is dependent on output of previous step, the generate step would fail since the outputs from previous steps are invalid. Precompilation is optional and only needs to be done once unless hyperparameters such as batch size are modified. After the optional precompilation, the actual run will be faster with minimal additional compilations. If precompilation was not done, the first execution of ./run.sh will be slower due to serial compilations. Rerunning the same script a second time would show quicker execution as the compiled graphs will be already cached in persistent cache. Running the above script will run the T5-small fine-tuning on a single process. **Note:** As you may have noticed, we are not running the `predict_with_generate` as part of training. This is because, `predict_with_generate` requires auto-regressive sampling where the inputs to the decoder are created by appending outputs of previous steps. This causes the inputs to the decoder to change shape and thereby resulting in a new graph. In other words, the current `generate` api provided by HF transformers leads to repeated compilations. We are working on building a Neuron friendly version of `generate` api and it will be made available as part of future release. This will enable us to run `predict_with_generate` as part of training script. As a workaround, we can run the `predict_with_generate` on CPU after the model is trained. Once training is completed, a trained checkpoint would be saved. We can load the trained model and run the `predict_with_generate` to compute the final accuracy. To do so, in run\_summarization.py, add the following before `transformers` get imported. This can be done by adding the below lines before all the `imports`: ``` import libneuronxla # Disable configuring xla env def _configure_env(): pass libneuronxla.configure_environment = _configure_env ``` You can now run the following and it should run the predict method on CPU device. ``` NEURON_NUM_DEVICES=0 python3 ./run_summarization.py \ --model_name_or_path <CHECKPOINT_DIR> \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_predict \ --predict_with_generate \ --source_prefix "summarize: " \ --per_device_eval_batch_size 4 \ --max_source_length 512 \ --pad_to_max_length \ --no_cuda \ --output_dir /tmp/tst-summarization |& tee log_run ``` Note: To run on CPU, we need to make sure that NEURON\_NUM\_DEVICES is set to 0. This will make sure no xla\_devices are created and the trainer would use the default device (CPU). ## [Multi-worker Training](#id4)[#](#multi-worker-training "Permalink to this headline") The above script will run one worker on one NeuronCore. To run on multiple cores, first add these lines to top of run\_summarization.py to disable Distributed Data Parallel (DDP) when using torchrun (see Known issues and limitations section below): ``` # Disable DDP for torchrun from transformers import __version__, Trainer Trainer._wrap_model = lambda self, model, training=True, dataloader=None: model ``` Then launch the run\_summarization.py script with torchrun using –nproc\_per\_node=N option to specify the number of workers (N=2 for trn1.2xlarge, and N=2, 8, or 32 for trn1.32xlarge). The following example runs 2 workers. Paste the following script into your terminal to create a “run\_2w.sh” file and change it to executable: ``` tee run_2w.sh > /dev/null <<EOF #!/bin/bash if [ \$NEURON_PARALLEL_COMPILE == "1" ] then XLA_USE_BF16=1 torchrun --nproc_per_node=2 ./run_summarization.py \ --model_name_or_path t5-small \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 32 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --max_steps 100 \ --max_eval_samples 100 \ --gradient_accumulation_steps=32 \ --output_dir /tmp/tst-summarization |& tee log_run else XLA_USE_BF16=1 torchrun --nproc_per_node=2 ./run_summarization.py \ --model_name_or_path t5-small \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 32 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --gradient_accumulation_steps=32 \ --output_dir /tmp/tst-summarization |& tee log_run fi EOF chmod +x run_2w.sh ``` Again, we optionally precompile the model and training script using neuron\_parallel\_compile to warm up the persistent graph cache (Neuron Cache), ignoring the results from this precompile run as it is only for extracting and compiling the XLA graphs: ``` neuron_parallel_compile ./run_2w.sh ``` Precompilation is optional and only needs to be done once unless hyperparameters such as batch size are modified. After the optional precompilation, the actual run will be faster with minimal additional compilations. During run, you will notice that the “Total train batch size” is now 8 and the “Total optimization steps” is now half the number for one worker training. Also, if you open `neuron-top` in a separate terminal, you should see 2 cores been utilized. To train T5-large model, you can set the `model_name_or_path` argument to `t5-large`. Please note, currently running `t5-large` on trn1-2xl machine can result in `HOST OOM` during compilation. Hence, it is recommended that you run a `t5-large` model training on a trn1-32xl machine. On a trn1-32xl machine, you can create a run\_32w.sh on the terminal using the following commands: ``` tee run_32w.sh > /dev/null <<EOF #!/bin/bash if [ \$NEURON_PARALLEL_COMPILE == "1" ] then XLA_USE_BF16=1 torchrun --nproc_per_node=32 ./run_summarization.py \ --model_name_or_path t5-large \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 4 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --max_steps 100 \ --max_eval_samples 100 \ --gradient_accumulation_steps=11 \ --output_dir /tmp/tst-summarization |& tee log_run else XLA_USE_BF16=1 torchrun --nproc_per_node=32 ./run_summarization.py \ --model_name_or_path t5-large \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 4 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --gradient_accumulation_steps=11 \ --output_dir /tmp/tst-summarization |& tee log_run fi EOF chmod +x run_32w.sh ``` You can now follow the same steps as listed above. This script would run a t5-large model by launching a training script using 32 data-parallel workers. ## [Known issues and limitations](#id5)[#](#known-issues-and-limitations "Permalink to this headline") The following are currently known issues: - Long compilation times: this can be alleviated with `neuron_parallel_compile` tool to extract graphs from a short trial run and compile them in parallel ahead of the actual run, as shown above. - T5-Large compilation causing processes to get killed on trn1-2xl: It is recommended to `t5-large` model training on a trn1-32xl machine, as it avoids CPU OOM and also provides faster training by making use of 32 data-parallel workers. _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Fine-tune T5 model on Trn1 — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="ZeRO-1 Tutorial" href="zero1_gpt2.html"> <link rel="prev" title="PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API" href="finetune_hftrainer.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/tutorials/training/finetune_t5", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-training-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/tutorials/training/finetune_t5.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-and-compilation"> Setup and compilation </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-training"> Single-worker training </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-worker-training"> Multi-worker Training </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known issues and limitations </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Fine-tune T5 model on Trn1</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-and-compilation"> Setup and compilation </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#single-worker-training"> Single-worker training </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-worker-training"> Multi-worker Training </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known issues and limitations </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="fine-tune-t5-model-on-trn1"> <span id="torch-hf-t5-finetune"></span><h1>Fine-tune T5 model on Trn1<a class="headerlink" href="#fine-tune-t5-model-on-trn1" title="Permalink to this headline">#</a></h1> <p>In this tutorial, we show how to fine-tune a Hugging Face (HF) T5 model using HF trainer API. This example fine-tunes a <a class="reference external" href="https://github.com/huggingface/transformers/tree/master/examples/pytorch/summarization">T5 model for a text-summarization</a> task on CNN/DailyMail dataset.</p> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#setup-and-compilation" id="id2">Setup and compilation</a></p></li> <li><p><a class="reference internal" href="#single-worker-training" id="id3">Single-worker training</a></p></li> <li><p><a class="reference internal" href="#multi-worker-training" id="id4">Multi-worker Training</a></p></li> <li><p><a class="reference internal" href="#known-issues-and-limitations" id="id5">Known issues and limitations</a></p></li> </ul> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Logs used in tutorials do not present latest performance numbers</p> <p>For latest performance numbers visit <a class="reference internal" href="../../../../../general/benchmarks/index.html#benchmark"><span class="std std-ref">Neuron Performance</span></a></p> </div> <div class="section" id="setup-and-compilation"> <h2><a class="toc-backref" href="#id2">Setup and compilation</a><a class="headerlink" href="#setup-and-compilation" title="Permalink to this headline">#</a></h2> <p>Before running the tutorial please follow the installation instructions at:</p> <p><a class="reference internal" href="../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx"><span class="std std-ref">Install PyTorch Neuron on Trn1</span></a></p> <p>Please set the storage of instance to <em>512GB</em> or more if you also want to run through the BERT pretraining and GPT pretraining tutorials.</p> <p>For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>~/aws_neuron_venv_pytorch/bin/activate </pre></div> </div> <p>First we install a recent version of HF transformers, scikit-learn and evaluate packages in our environment as well as download the source matching the installed version. In this example, we chose version 4.26.0 and the text summarization example from HF transformers source:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">HF_VER</span><span class="o">=</span><span class="m">4</span>.26.0 pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span><span class="nv">transformers</span><span class="o">==</span><span class="nv">$HF_VER</span><span class="w"> </span>datasets<span class="w"> </span>evaluate<span class="w"> </span>scikit-learn<span class="w"> </span>rouge_score<span class="w"> </span><span class="nv">pandas</span><span class="o">==</span><span class="m">1</span>.4.0 <span class="nb">cd</span><span class="w"> </span>~/ git<span class="w"> </span>clone<span class="w"> </span>https://github.com/huggingface/transformers<span class="w"> </span>--branch<span class="w"> </span>v<span class="nv">$HF_VER</span> <span class="nb">cd</span><span class="w"> </span>~/transformers/examples/pytorch/summarization </pre></div> </div> </div> <div class="section" id="single-worker-training"> <h2><a class="toc-backref" href="#id3">Single-worker training</a><a class="headerlink" href="#single-worker-training" title="Permalink to this headline">#</a></h2> <p>We will run text-summarization fine-tuning task following the example in README.md located in the path <cite>~/transformers/examples/pytorch/summarization.</cite></p> <p>We use full BF16 casting using <cite>XLA_USE_BF16=1</cite> to enable best performance. First, paste the following script into your terminal to create a “run.sh” file and change it to executable:</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span>tee run.sh &gt; /dev/null &lt;&lt;EOF #!/bin/bash if [ \$NEURON_PARALLEL_COMPILE == "1" ] then XLA_USE_BF16=1 python3 ./run_summarization.py \ --model_name_or_path t5-small \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 32 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --max_steps 100 \ --max_eval_samples 100 \ --gradient_accumulation_steps=32 \ --output_dir /tmp/tst-summarization |&amp; tee log_run else XLA_USE_BF16=1 python3 ./run_summarization.py \ --model_name_or_path t5-small \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 32 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --gradient_accumulation_steps=32 \ --output_dir /tmp/tst-summarization |&amp; tee log_run fi EOF chmod +x run.sh </pre></div> </div> <p>We optionally precompile the model and training script using <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html?highlight=neuron_parallel_compile">neuron_parallel_compile</a> to warm up the persistent graph cache (Neuron Cache) such that the actual run has fewer compilations (faster run time):</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">neuron_parallel_compile</span> <span class="o">./</span><span class="n">run</span><span class="o">.</span><span class="n">sh</span> </pre></div> </div> <p>Note: For these auto-regressive models, do not run the <code class="docutils literal notranslate"><span class="pre">predict_with_generate</span></code> method when doing the precompile step. This is because the <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> utility will run the training script in graph extraction mode and no actual execution of the graph will be done. Hence, the outputs at each step are invalid. Since the auto-regressive generation at each step is dependent on output of previous step, the generate step would fail since the outputs from previous steps are invalid.</p> <p>Precompilation is optional and only needs to be done once unless hyperparameters such as batch size are modified. After the optional precompilation, the actual run will be faster with minimal additional compilations.</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">run</span><span class="o">.</span><span class="n">sh</span> </pre></div> </div> <p>If precompilation was not done, the first execution of ./run.sh will be slower due to serial compilations. Rerunning the same script a second time would show quicker execution as the compiled graphs will be already cached in persistent cache.</p> <p>Running the above script will run the T5-small fine-tuning on a single process.</p> <p><strong>Note:</strong> As you may have noticed, we are not running the <code class="docutils literal notranslate"><span class="pre">predict_with_generate</span></code> as part of training. This is because, <code class="docutils literal notranslate"><span class="pre">predict_with_generate</span></code> requires auto-regressive sampling where the inputs to the decoder are created by appending outputs of previous steps. This causes the inputs to the decoder to change shape and thereby resulting in a new graph. In other words, the current <code class="docutils literal notranslate"><span class="pre">generate</span></code> api provided by HF transformers leads to repeated compilations. We are working on building a Neuron friendly version of <code class="docutils literal notranslate"><span class="pre">generate</span></code> api and it will be made available as part of future release. This will enable us to run <code class="docutils literal notranslate"><span class="pre">predict_with_generate</span></code> as part of training script.</p> <p>As a workaround, we can run the <code class="docutils literal notranslate"><span class="pre">predict_with_generate</span></code> on CPU after the model is trained. Once training is completed, a trained checkpoint would be saved. We can load the trained model and run the <code class="docutils literal notranslate"><span class="pre">predict_with_generate</span></code> to compute the final accuracy.</p> <p>To do so, in run_summarization.py, add the following before <code class="docutils literal notranslate"><span class="pre">transformers</span></code> get imported. This can be done by adding the below lines before all the <code class="docutils literal notranslate"><span class="pre">imports</span></code>:</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">libneuronxla</span> <span class="c1"># Disable configuring xla env</span> <span class="k">def</span> <span class="nf">_configure_env</span><span class="p">():</span> <span class="k">pass</span> <span class="n">libneuronxla</span><span class="o">.</span><span class="n">configure_environment</span> <span class="o">=</span> <span class="n">_configure_env</span> </pre></div> </div> <p>You can now run the following and it should run the predict method on CPU device.</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">NEURON_NUM_DEVICES</span><span class="o">=</span><span class="mi">0</span> <span class="n">python3</span> <span class="o">./</span><span class="n">run_summarization</span><span class="o">.</span><span class="n">py</span> \ <span class="o">--</span><span class="n">model_name_or_path</span> <span class="o">&lt;</span><span class="n">CHECKPOINT_DIR</span><span class="o">&gt;</span> \ <span class="o">--</span><span class="n">dataset_name</span> <span class="n">cnn_dailymail</span> \ <span class="o">--</span><span class="n">dataset_config</span> <span class="s2">"3.0.0"</span> \ <span class="o">--</span><span class="n">do_predict</span> \ <span class="o">--</span><span class="n">predict_with_generate</span> \ <span class="o">--</span><span class="n">source_prefix</span> <span class="s2">"summarize: "</span> \ <span class="o">--</span><span class="n">per_device_eval_batch_size</span> <span class="mi">4</span> \ <span class="o">--</span><span class="n">max_source_length</span> <span class="mi">512</span> \ <span class="o">--</span><span class="n">pad_to_max_length</span> \ <span class="o">--</span><span class="n">no_cuda</span> \ <span class="o">--</span><span class="n">output_dir</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">tst</span><span class="o">-</span><span class="n">summarization</span> <span class="o">|&amp;</span> <span class="n">tee</span> <span class="n">log_run</span> </pre></div> </div> <p>Note: To run on CPU, we need to make sure that NEURON_NUM_DEVICES is set to 0. This will make sure no xla_devices are created and the trainer would use the default device (CPU).</p> </div> <div class="section" id="multi-worker-training"> <span id="id1"></span><h2><a class="toc-backref" href="#id4">Multi-worker Training</a><a class="headerlink" href="#multi-worker-training" title="Permalink to this headline">#</a></h2> <p>The above script will run one worker on one NeuronCore. To run on multiple cores, first add these lines to top of run_summarization.py to disable Distributed Data Parallel (DDP) when using torchrun (see Known issues and limitations section below):</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Disable DDP for torchrun</span> <span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">__version__</span><span class="p">,</span> <span class="n">Trainer</span> <span class="n">Trainer</span><span class="o">.</span><span class="n">_wrap_model</span> <span class="o">=</span> <span class="k">lambda</span> <span class="bp">self</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">training</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">dataloader</span><span class="o">=</span><span class="kc">None</span><span class="p">:</span> <span class="n">model</span> </pre></div> </div> <p>Then launch the run_summarization.py script with torchrun using –nproc_per_node=N option to specify the number of workers (N=2 for trn1.2xlarge, and N=2, 8, or 32 for trn1.32xlarge). The following example runs 2 workers. Paste the following script into your terminal to create a “run_2w.sh” file and change it to executable:</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span>tee run_2w.sh &gt; /dev/null &lt;&lt;EOF #!/bin/bash if [ \$NEURON_PARALLEL_COMPILE == "1" ] then XLA_USE_BF16=1 torchrun --nproc_per_node=2 ./run_summarization.py \ --model_name_or_path t5-small \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 32 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --max_steps 100 \ --max_eval_samples 100 \ --gradient_accumulation_steps=32 \ --output_dir /tmp/tst-summarization |&amp; tee log_run else XLA_USE_BF16=1 torchrun --nproc_per_node=2 ./run_summarization.py \ --model_name_or_path t5-small \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 32 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --gradient_accumulation_steps=32 \ --output_dir /tmp/tst-summarization |&amp; tee log_run fi EOF chmod +x run_2w.sh </pre></div> </div> <p>Again, we optionally precompile the model and training script using neuron_parallel_compile to warm up the persistent graph cache (Neuron Cache), ignoring the results from this precompile run as it is only for extracting and compiling the XLA graphs:</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">neuron_parallel_compile</span> <span class="o">./</span><span class="n">run_2w</span><span class="o">.</span><span class="n">sh</span> </pre></div> </div> <p>Precompilation is optional and only needs to be done once unless hyperparameters such as batch size are modified. After the optional precompilation, the actual run will be faster with minimal additional compilations.</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">run_2w</span><span class="o">.</span><span class="n">sh</span> </pre></div> </div> <p>During run, you will notice that the “Total train batch size” is now 8 and the “Total optimization steps” is now half the number for one worker training. Also, if you open <code class="docutils literal notranslate"><span class="pre">neuron-top</span></code> in a separate terminal, you should see 2 cores been utilized.</p> <p>To train T5-large model, you can set the <code class="docutils literal notranslate"><span class="pre">model_name_or_path</span></code> argument to <code class="docutils literal notranslate"><span class="pre">t5-large</span></code>. Please note, currently running <code class="docutils literal notranslate"><span class="pre">t5-large</span></code> on trn1-2xl machine can result in <code class="docutils literal notranslate"><span class="pre">HOST</span> <span class="pre">OOM</span></code> during compilation. Hence, it is recommended that you run a <code class="docutils literal notranslate"><span class="pre">t5-large</span></code> model training on a trn1-32xl machine.</p> <p>On a trn1-32xl machine, you can create a run_32w.sh on the terminal using the following commands:</p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span>tee run_32w.sh &gt; /dev/null &lt;&lt;EOF #!/bin/bash if [ \$NEURON_PARALLEL_COMPILE == "1" ] then XLA_USE_BF16=1 torchrun --nproc_per_node=32 ./run_summarization.py \ --model_name_or_path t5-large \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 4 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --max_steps 100 \ --max_eval_samples 100 \ --gradient_accumulation_steps=11 \ --output_dir /tmp/tst-summarization |&amp; tee log_run else XLA_USE_BF16=1 torchrun --nproc_per_node=32 ./run_summarization.py \ --model_name_or_path t5-large \ --dataset_name cnn_dailymail \ --dataset_config "3.0.0" \ --do_train \ --do_eval \ --source_prefix "summarize: " \ --max_source_length 512 \ --per_device_train_batch_size 4 \ --per_device_eval_batch_size 4 \ --overwrite_output_dir \ --pad_to_max_length \ --gradient_accumulation_steps=11 \ --output_dir /tmp/tst-summarization |&amp; tee log_run fi EOF chmod +x run_32w.sh </pre></div> </div> <p>You can now follow the same steps as listed above. This script would run a t5-large model by launching a training script using 32 data-parallel workers.</p> </div> <div class="section" id="known-issues-and-limitations"> <span id="known-issues"></span><h2><a class="toc-backref" href="#id5">Known issues and limitations</a><a class="headerlink" href="#known-issues-and-limitations" title="Permalink to this headline">#</a></h2> <p>The following are currently known issues:</p> <ul class="simple"> <li><p>Long compilation times: this can be alleviated with <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> tool to extract graphs from a short trial run and compile them in parallel ahead of the actual run, as shown above.</p></li> <li><p>T5-Large compilation causing processes to get killed on trn1-2xl: It is recommended to <code class="docutils literal notranslate"><span class="pre">t5-large</span></code> model training on a trn1-32xl machine, as it avoids CPU OOM and also provides faster training by making use of 32 data-parallel workers.</p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="finetune_hftrainer.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API</p> </div> </a> <a class="right-next" id="next-link" href="zero1_gpt2.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">ZeRO-1 Tutorial</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:05.601Z
Analyze for Training Tutorial — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html
# Analyze for Training Tutorial — AWS Neuron Documentation ## Contents - [Setup](#setup) - [Running `analyze` via `neuron_parallel_compile`](#running-analyze-via-neuron-parallel-compile) - [Understanding `analyze` report for Unsupported Models](#understanding-analyze-report-for-unsupported-models) - [Default Verbosity](#default-verbosity) - [Lower Level Verbosity](#lower-level-verbosity) _This document is relevant for_: `Trn1`, `Trn1n` ## Analyze for Training Tutorial[#](#analyze-for-training-tutorial "Permalink to this headline") This tutorial explains how to analyze a model for training support using via `torch-neuronx`. ## Setup[#](#setup "Permalink to this headline") For this tutorial we’ll be using two scripts: `supported.py` and `unsupported.py`. Create these files by copy pasting the below code to their respective files. `supported.py` ``` import torch import torch_xla.core.xla_model as xm class NN(torch.nn.Module): def __init__(self): super().__init__() self.layer1 = torch.nn.Linear(4,4) self.nl1 = torch.nn.ReLU() self.layer2 = torch.nn.Linear(4,2) self.nl2 = torch.nn.Tanh() def forward(self, x): x = self.nl1(self.layer1(x)) return self.nl2(self.layer2(x)) def main(): device = xm.xla_device() model = NN().to(device) optimizer = torch.optim.SGD(model.parameters(), lr=0.01) loss_fn = torch.nn.MSELoss() inp = torch.rand(4) target = torch.tensor([1,0]) model.train() for epoch in range(2): optimizer.zero_grad() inp = inp.to(device) target = target.to(device) output = model(inp) loss = loss_fn(output,target) loss.backward() optimizer.step() xm.mark_step() if __name__ == '__main__': main() ``` `unsupported.py` ``` import torch import torch_xla.core.xla_model as xm class UnsupportedModel(torch.nn.Module): def __init__(self): super().__init__() def forward(self, x): y = torch.fft.fft(x) x = x + 10 return x * y def main(): device = xm.xla_device() model = UnsupportedModel().to(device) inp = torch.rand(4) model.train() for epoch in range(1): inp = inp.to(device) output = model(inp) xm.mark_step() if __name__ == '__main__': main() ``` ## Running `analyze` via `neuron_parallel_compile`[#](#running-analyze-via-neuron-parallel-compile "Permalink to this headline") To analyze a model, we supply the training script to the `analyze` command, which is shipped with `neuron_parallel_compile`. The command is: ``` neuron_parallel_compile --command analyze python supported.py ``` This will generate a lot of output showing a lot of compilation statuses. Here’s a snippet of the output when running the above command. ``` .2023-05-25 00:43:43.000394: 776642 INFO ||ANALYZE||: Compiling /tmp/model_analyis_graphs/compare_7841189860629745939_23.hlo.pb using following command: neuronx-cc compile --target=trn1 --framework XLA /tmp/model_analyis_graphs/compare_7841189860629745939_23.hlo.pb --verbose=35 --query-compute-placement 2023-05-25 00:43:43.000418: 776642 INFO ||ANALYZE||: Compiling /tmp/model_analyis_graphs/multiply_15640857564712679356_53.hlo.pb using following command: neuronx-cc compile --target=trn1 --framework XLA /tmp/model_analyis_graphs/multiply_15640857564712679356_53.hlo.pb --verbose=35 --query-compute-placement . Compiler status PASS 2023-05-25 00:43:43.000549: 776642 INFO ||ANALYZE||: Compiling /tmp/model_analyis_graphs/subtract_1927104012014828209_49.hlo.pb using following command: neuronx-cc compile --target=trn1 --framework XLA /tmp/model_analyis_graphs/subtract_1927104012014828209_49.hlo.pb --verbose=35 --query-compute-placement ... Compiler status PASS ``` The analysis report will be generated as a JSON file. The location of the report is shown as the last log entry: ``` 2023-05-25 00:43:49.000252: 776642 INFO ||ANALYZE||: Removing existing report /home/ubuntu/analyze_for_training/model_analysis_result/result.json 2023-05-25 00:43:49.000252: 776642 INFO ||ANALYZE||: Model analysis completed. Report - /home/ubuntu/analyze_for_training/model_analysis_result/result.json ``` Note Note that if a report is already present in the specified path, `analyze` will remove/overwrite it. The report generated running the above command looks like: ``` { "torch_neuronx_version": "1.13.0.1.6.1", "neuronx_cc_version": "2.5.0.28+1be23f232", "support_percentage": "100.00%", "supported_operators": { "aten": { "aten::permute": 8, "aten::add": 8, "aten::mul": 8, "aten::expand": 18, "aten::mm": 10, "aten::mse_loss_backward": 12, "aten::relu": 3, "aten::threshold_backward": 4, "aten::squeeze": 4, "aten::view": 4, "aten::pow": 2, "aten::mse_loss": 2, "aten::tanh": 2 } }, "unsupported_operators": { "aten": [] } } ``` Note Note that the `torch_neuronx` and `neuronx_cc` versions may be different from this example ## Understanding `analyze` report for Unsupported Models[#](#understanding-analyze-report-for-unsupported-models "Permalink to this headline") ### Default Verbosity[#](#default-verbosity "Permalink to this headline") Let’s run `analyze` for `unsupported.py` ``` neuron_parallel_compile --command analyze python unsupported.py ``` Here is the report generated by the above command: ``` { "torch_neuronx_version": "1.13.0.1.6.1", "neuronx_cc_version": "2.5.0.28+1be23f232", "support_percentage": "60.00%", "supported_operators": { "aten": { "aten::add": 2, "aten::mul": 1 } }, "unsupported_operators": { "aten": [ { "kind": "aten::mul", "failureAt": "neuronx-cc", "call": "test2_unsup.py 24" } ] } } ``` In the list of unsupported operators we are provided the specific aten op that failed, and where that operator is in the training script. One thing to notice is that the `support_percentage` doesn’t exactly add up. This is because the `support_percentage` is calculated based on the supported number of XLA/HLO instructions (explained more in the next section). To see the specific XLA/HLO op lowerings, use the flag `--analyze-verbosity 1`, as the default is `2`. The last thing is that a specific aten operator can be supported and unsupported simultaneously. In our example, this can be seen with `aten::mul`. This is due to the configuration of the aten op. The below section will describe what went wrong with the `aten::mul` op. ### Lower Level Verbosity[#](#lower-level-verbosity "Permalink to this headline") Let’s run again with lower verbosity level: ``` neuron_parallel_compile --command analyze --analyze-verbosity 1 python unsupported.py ``` The report looks like: ``` { "torch_neuronx_version": "1.13.0.1.6.1", "neuronx_cc_version": "2.5.0.28+1be23f232", "support_percentage": "60.00%", "supported_operators": { "aten": { "aten::mul": 1, "aten::add": 2 }, "xla": [ "f32[] multiply(f32[], f32[])", "f32[4]{0} broadcast(f32[]), dimensions={}", "f32[4]{0} add(f32[4]{0}, f32[4]{0})" ] }, "unsupported_operators": { "aten": [ { "kind": "aten::mul", "failureAt": "neuronx-cc", "call": "test2_unsup.py 24" } ], "xla": [ { "hlo_instruction": "c64[4]{0} convert(f32[4]{0})", "aten_op": "aten::mul" }, { "hlo_instruction": "c64[4]{0} multiply(c64[4]{0}, c64[4]{0})", "aten_op": "aten::mul" } ] } } ``` This report provides both the aten operator and the failed XLA/HLO instructions. There will be more HLO instructions than aten ops since an aten op generally lowers to multiple HLO instructions. As a result, the `support_percentage` field doesn’t exactly line up with the aten operator count, but does line up the XLA/HLO instruction count. This level of verbosity is intended for use when you have the ability to modify the model’s HLO lowering, or generally have insight into the HLO lowering. As mentioned before, the `aten::mul` op appears to be both supported and unsupported. This is because the compiler does not support a specific configuration of `aten::mul`, which can be seen more clearly with the HLO lowering. In the above example, the `aten::mul` operator is unsupported since at least one parameter provided was a complex type (`C64`), which is unsupported by `neuronx-cc`. This concludes the tutorial. The API for `analyze` can be found within [neuron\_parallel\_compile](../../api-reference-guide/training/pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli) _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Analyze for Training Tutorial — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Neuron Custom C++ Operators in MLP Training" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> <link rel="prev" title="ZeRO-1 Tutorial" href="zero1_gpt2.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-training-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup"> Setup </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#running-analyze-via-neuron-parallel-compile"> Running <code class="docutils literal notranslate"> <span class="pre"> analyze </span> </code> via <code class="docutils literal notranslate"> <span class="pre"> neuron_parallel_compile </span> </code> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#understanding-analyze-report-for-unsupported-models"> Understanding <code class="docutils literal notranslate"> <span class="pre"> analyze </span> </code> report for Unsupported Models </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-verbosity"> Default Verbosity </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#lower-level-verbosity"> Lower Level Verbosity </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Analyze for Training Tutorial</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup"> Setup </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#running-analyze-via-neuron-parallel-compile"> Running <code class="docutils literal notranslate"> <span class="pre"> analyze </span> </code> via <code class="docutils literal notranslate"> <span class="pre"> neuron_parallel_compile </span> </code> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#understanding-analyze-report-for-unsupported-models"> Understanding <code class="docutils literal notranslate"> <span class="pre"> analyze </span> </code> report for Unsupported Models </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#default-verbosity"> Default Verbosity </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#lower-level-verbosity"> Lower Level Verbosity </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="analyze-for-training-tutorial"> <span id="torch-analyze-for-training-tutorial"></span><h1>Analyze for Training Tutorial<a class="headerlink" href="#analyze-for-training-tutorial" title="Permalink to this headline">#</a></h1> <p>This tutorial explains how to analyze a model for training support using via <code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>For analyzing models for inference support via <code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>, please refer to <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html#torch-neuronx-analyze-api"><span class="std std-ref">torch_neuronx.analyze()</span></a></p> </div> <div class="section" id="setup"> <h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">#</a></h2> <p>For this tutorial we’ll be using two scripts: <code class="docutils literal notranslate"><span class="pre">supported.py</span></code> and <code class="docutils literal notranslate"><span class="pre">unsupported.py</span></code>. Create these files by copy pasting the below code to their respective files.</p> <p><code class="docutils literal notranslate"><span class="pre">supported.py</span></code></p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="k">class</span> <span class="nc">NN</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">layer1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span><span class="mi">4</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">nl1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">ReLU</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">layer2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">nl2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Tanh</span><span class="p">()</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="n">x</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nl1</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">layer1</span><span class="p">(</span><span class="n">x</span><span class="p">))</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">nl2</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">layer2</span><span class="p">(</span><span class="n">x</span><span class="p">))</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="n">model</span> <span class="o">=</span> <span class="n">NN</span><span class="p">()</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">optimizer</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">optim</span><span class="o">.</span><span class="n">SGD</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">parameters</span><span class="p">(),</span> <span class="n">lr</span><span class="o">=</span><span class="mf">0.01</span><span class="p">)</span> <span class="n">loss_fn</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">MSELoss</span><span class="p">()</span> <span class="n">inp</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span> <span class="n">target</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">])</span> <span class="n">model</span><span class="o">.</span><span class="n">train</span><span class="p">()</span> <span class="k">for</span> <span class="n">epoch</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">2</span><span class="p">):</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">zero_grad</span><span class="p">()</span> <span class="n">inp</span> <span class="o">=</span> <span class="n">inp</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">target</span> <span class="o">=</span> <span class="n">target</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">inp</span><span class="p">)</span> <span class="n">loss</span> <span class="o">=</span> <span class="n">loss_fn</span><span class="p">(</span><span class="n">output</span><span class="p">,</span><span class="n">target</span><span class="p">)</span> <span class="n">loss</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">step</span><span class="p">()</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span> <span class="n">main</span><span class="p">()</span> </pre></div> </div> <p><code class="docutils literal notranslate"><span class="pre">unsupported.py</span></code></p> <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="k">class</span> <span class="nc">UnsupportedModel</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="n">y</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">fft</span><span class="o">.</span><span class="n">fft</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="n">x</span> <span class="o">=</span> <span class="n">x</span> <span class="o">+</span> <span class="mi">10</span> <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="n">y</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="n">model</span> <span class="o">=</span> <span class="n">UnsupportedModel</span><span class="p">()</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">inp</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">train</span><span class="p">()</span> <span class="k">for</span> <span class="n">epoch</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">):</span> <span class="n">inp</span> <span class="o">=</span> <span class="n">inp</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">output</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">inp</span><span class="p">)</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span> <span class="n">main</span><span class="p">()</span> </pre></div> </div> </div> <div class="section" id="running-analyze-via-neuron-parallel-compile"> <h2>Running <code class="docutils literal notranslate"><span class="pre">analyze</span></code> via <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code><a class="headerlink" href="#running-analyze-via-neuron-parallel-compile" title="Permalink to this headline">#</a></h2> <p>To analyze a model, we supply the training script to the <code class="docutils literal notranslate"><span class="pre">analyze</span></code> command, which is shipped with <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code>. The command is:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>neuron_parallel_compile<span class="w"> </span>--command<span class="w"> </span>analyze<span class="w"> </span>python<span class="w"> </span>supported.py </pre></div> </div> <p>This will generate a lot of output showing a lot of compilation statuses. Here’s a snippet of the output when running the above command.</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>.2023-05-25<span class="w"> </span><span class="m">00</span>:43:43.000394:<span class="w"> </span><span class="m">776642</span><span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>ANALYZE<span class="o">||</span>:<span class="w"> </span>Compiling<span class="w"> </span>/tmp/model_analyis_graphs/compare_7841189860629745939_23.hlo.pb<span class="w"> </span>using<span class="w"> </span>following<span class="w"> </span>command:<span class="w"> </span>neuronx-cc<span class="w"> </span>compile<span class="w"> </span>--target<span class="o">=</span>trn1<span class="w"> </span>--framework<span class="w"> </span>XLA<span class="w"> </span>/tmp/model_analyis_graphs/compare_7841189860629745939_23.hlo.pb<span class="w"> </span>--verbose<span class="o">=</span><span class="m">35</span><span class="w"> </span>--query-compute-placement <span class="m">2023</span>-05-25<span class="w"> </span><span class="m">00</span>:43:43.000418:<span class="w"> </span><span class="m">776642</span><span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>ANALYZE<span class="o">||</span>:<span class="w"> </span>Compiling<span class="w"> </span>/tmp/model_analyis_graphs/multiply_15640857564712679356_53.hlo.pb<span class="w"> </span>using<span class="w"> </span>following<span class="w"> </span>command:<span class="w"> </span>neuronx-cc<span class="w"> </span>compile<span class="w"> </span>--target<span class="o">=</span>trn1<span class="w"> </span>--framework<span class="w"> </span>XLA<span class="w"> </span>/tmp/model_analyis_graphs/multiply_15640857564712679356_53.hlo.pb<span class="w"> </span>--verbose<span class="o">=</span><span class="m">35</span><span class="w"> </span>--query-compute-placement . Compiler<span class="w"> </span>status<span class="w"> </span>PASS <span class="m">2023</span>-05-25<span class="w"> </span><span class="m">00</span>:43:43.000549:<span class="w"> </span><span class="m">776642</span><span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>ANALYZE<span class="o">||</span>:<span class="w"> </span>Compiling<span class="w"> </span>/tmp/model_analyis_graphs/subtract_1927104012014828209_49.hlo.pb<span class="w"> </span>using<span class="w"> </span>following<span class="w"> </span>command:<span class="w"> </span>neuronx-cc<span class="w"> </span>compile<span class="w"> </span>--target<span class="o">=</span>trn1<span class="w"> </span>--framework<span class="w"> </span>XLA<span class="w"> </span>/tmp/model_analyis_graphs/subtract_1927104012014828209_49.hlo.pb<span class="w"> </span>--verbose<span class="o">=</span><span class="m">35</span><span class="w"> </span>--query-compute-placement ... Compiler<span class="w"> </span>status<span class="w"> </span>PASS </pre></div> </div> <p>The analysis report will be generated as a JSON file. The location of the report is shown as the last log entry:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="m">2023</span>-05-25<span class="w"> </span><span class="m">00</span>:43:49.000252:<span class="w"> </span><span class="m">776642</span><span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>ANALYZE<span class="o">||</span>:<span class="w"> </span>Removing<span class="w"> </span>existing<span class="w"> </span>report<span class="w"> </span>/home/ubuntu/analyze_for_training/model_analysis_result/result.json <span class="m">2023</span>-05-25<span class="w"> </span><span class="m">00</span>:43:49.000252:<span class="w"> </span><span class="m">776642</span><span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>ANALYZE<span class="o">||</span>:<span class="w"> </span>Model<span class="w"> </span>analysis<span class="w"> </span>completed.<span class="w"> </span>Report<span class="w"> </span>-<span class="w"> </span>/home/ubuntu/analyze_for_training/model_analysis_result/result.json </pre></div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Note that if a report is already present in the specified path, <code class="docutils literal notranslate"><span class="pre">analyze</span></code> will remove/overwrite it.</p> </div> <p>The report generated running the above command looks like:</p> <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="nt">"torch_neuronx_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.13.0.1.6.1"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"neuronx_cc_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.5.0.28+1be23f232"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"support_percentage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"100.00%"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"supported_operators"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"aten"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"aten::permute"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::add"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::mul"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::expand"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::mm"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::mse_loss_backward"</span><span class="p">:</span><span class="w"> </span><span class="mi">12</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::relu"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::threshold_backward"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::squeeze"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::view"</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::pow"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::mse_loss"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::tanh"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"unsupported_operators"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"aten"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Note that the <code class="docutils literal notranslate"><span class="pre">torch_neuronx</span></code> and <code class="docutils literal notranslate"><span class="pre">neuronx_cc</span></code> versions may be different from this example</p> </div> </div> <div class="section" id="understanding-analyze-report-for-unsupported-models"> <h2>Understanding <code class="docutils literal notranslate"><span class="pre">analyze</span></code> report for Unsupported Models<a class="headerlink" href="#understanding-analyze-report-for-unsupported-models" title="Permalink to this headline">#</a></h2> <div class="section" id="default-verbosity"> <h3>Default Verbosity<a class="headerlink" href="#default-verbosity" title="Permalink to this headline">#</a></h3> <p>Let’s run <code class="docutils literal notranslate"><span class="pre">analyze</span></code> for <code class="docutils literal notranslate"><span class="pre">unsupported.py</span></code></p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>neuron_parallel_compile<span class="w"> </span>--command<span class="w"> </span>analyze<span class="w"> </span>python<span class="w"> </span>unsupported.py </pre></div> </div> <p>Here is the report generated by the above command:</p> <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="nt">"torch_neuronx_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.13.0.1.6.1"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"neuronx_cc_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.5.0.28+1be23f232"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"support_percentage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"60.00%"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"supported_operators"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"aten"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"aten::add"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::mul"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"unsupported_operators"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"aten"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"kind"</span><span class="p">:</span><span class="w"> </span><span class="s2">"aten::mul"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"failureAt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"neuronx-cc"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"call"</span><span class="p">:</span><span class="w"> </span><span class="s2">"test2_unsup.py 24"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> <p>In the list of unsupported operators we are provided the specific aten op that failed, and where that operator is in the training script.</p> <p>One thing to notice is that the <code class="docutils literal notranslate"><span class="pre">support_percentage</span></code> doesn’t exactly add up. This is because the <code class="docutils literal notranslate"><span class="pre">support_percentage</span></code> is calculated based on the supported number of XLA/HLO instructions (explained more in the next section). To see the specific XLA/HLO op lowerings, use the flag <code class="docutils literal notranslate"><span class="pre">--analyze-verbosity</span> <span class="pre">1</span></code>, as the default is <code class="docutils literal notranslate"><span class="pre">2</span></code>.</p> <p>The last thing is that a specific aten operator can be supported and unsupported simultaneously. In our example, this can be seen with <code class="docutils literal notranslate"><span class="pre">aten::mul</span></code>. This is due to the configuration of the aten op. The below section will describe what went wrong with the <code class="docutils literal notranslate"><span class="pre">aten::mul</span></code> op.</p> </div> <div class="section" id="lower-level-verbosity"> <h3>Lower Level Verbosity<a class="headerlink" href="#lower-level-verbosity" title="Permalink to this headline">#</a></h3> <p>Let’s run again with lower verbosity level:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>neuron_parallel_compile<span class="w"> </span>--command<span class="w"> </span>analyze<span class="w"> </span>--analyze-verbosity<span class="w"> </span><span class="m">1</span><span class="w"> </span>python<span class="w"> </span>unsupported.py </pre></div> </div> <p>The report looks like:</p> <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="nt">"torch_neuronx_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.13.0.1.6.1"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"neuronx_cc_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.5.0.28+1be23f232"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"support_percentage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"60.00%"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"supported_operators"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"aten"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"aten::mul"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten::add"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"xla"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="s2">"f32[] multiply(f32[], f32[])"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"f32[4]{0} broadcast(f32[]), dimensions={}"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"f32[4]{0} add(f32[4]{0}, f32[4]{0})"</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="nt">"unsupported_operators"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"aten"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"kind"</span><span class="p">:</span><span class="w"> </span><span class="s2">"aten::mul"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"failureAt"</span><span class="p">:</span><span class="w"> </span><span class="s2">"neuronx-cc"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"call"</span><span class="p">:</span><span class="w"> </span><span class="s2">"test2_unsup.py 24"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="nt">"xla"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"hlo_instruction"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c64[4]{0} convert(f32[4]{0})"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten_op"</span><span class="p">:</span><span class="w"> </span><span class="s2">"aten::mul"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="nt">"hlo_instruction"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c64[4]{0} multiply(c64[4]{0}, c64[4]{0})"</span><span class="p">,</span> <span class="w"> </span><span class="nt">"aten_op"</span><span class="p">:</span><span class="w"> </span><span class="s2">"aten::mul"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> <p>This report provides both the aten operator and the failed XLA/HLO instructions. There will be more HLO instructions than aten ops since an aten op generally lowers to multiple HLO instructions. As a result, the <code class="docutils literal notranslate"><span class="pre">support_percentage</span></code> field doesn’t exactly line up with the aten operator count, but does line up the XLA/HLO instruction count. This level of verbosity is intended for use when you have the ability to modify the model’s HLO lowering, or generally have insight into the HLO lowering.</p> <p>As mentioned before, the <code class="docutils literal notranslate"><span class="pre">aten::mul</span></code> op appears to be both supported and unsupported. This is because the compiler does not support a specific configuration of <code class="docutils literal notranslate"><span class="pre">aten::mul</span></code>, which can be seen more clearly with the HLO lowering. In the above example, the <code class="docutils literal notranslate"><span class="pre">aten::mul</span></code> operator is unsupported since at least one parameter provided was a complex type (<code class="docutils literal notranslate"><span class="pre">C64</span></code>), which is unsupported by <code class="docutils literal notranslate"><span class="pre">neuronx-cc</span></code>.</p> <p>This concludes the tutorial. The API for <code class="docutils literal notranslate"><span class="pre">analyze</span></code> can be found within <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">neuron_parallel_compile</span></a></p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="zero1_gpt2.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">ZeRO-1 Tutorial</p> </div> </a> <a class="right-next" id="next-link" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Neuron Custom C++ Operators in MLP Training</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:06.057Z
Neuron Custom C++ Operators in MLP Training — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/neuron-customops/tutorials/customop-mlp-training.html
# Neuron Custom C++ Operators in MLP Training — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Neuron Custom C++ Operators in MLP Training[#](#neuron-custom-c-operators-in-mlp-training "Permalink to this headline") In this tutorial we’ll demonstrate how to prepare a PyTorch model that contains a custom operator (ie. CppExtension) for Neuron compilation to run on Trainium EC2 instances. To learn more about Neuron CustomOps see [Neuron Custom C++ Operators \[Experimental\]](../index.html#neuron-c-customops). For a deeper dive on MNIST or Multi-Layer Perceptron models, see the [Multi-Layer Perceptron Training Tutorial](../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html#neuronx-mlp-training-tutorial). This tutorial assumes the reader is familiar with [PyTorch Custom Extensions](https://pytorch.org/tutorials/advanced/cpp_extension.html). Table of Contents - [Setup Environment and Download Examples](#setup-environment-and-download-examples) - [Basic PyTorch Custom Relu Operator](#basic-pytorch-custom-relu-operator) - [Multi-layer perceptron MNIST model](#multi-layer-perceptron-mnist-model) - [Training the MLP model on CPU](#training-the-mlp-model-on-cpu) - [Neuron Relu CustomOp](#neuron-relu-customop) - [Training the MLP model on Trainium](#training-the-mlp-model-on-trainium) ## [Setup Environment and Download Examples](#id1)[#](#setup-environment-and-download-examples "Permalink to this headline") Before running the tutorial please follow the installation instructions at: - [Install PyTorch Neuron (torch-neuronx)](../../frameworks/torch/torch-neuronx/setup/pytorch-install.html#pytorch-neuronx-install) on Trn1 Note The name of `aws-neuronx-gpsimd-customop` has been changed to `aws-neuronx-gpsimd-customop-lib` as of the neuron 2.10 release. Note Custom C++ Operators are supported as of Neuron SDK Version 2.7 as a beta feature. As such this feature is not installed by default. Additional tooling and library packages (RPM and DEB) are required. On AL2, they can be installed with the following commands: ``` sudo yum remove python3-devel -y sudo yum remove aws-neuronx-gpsimd-tools-0.* -y sudo yum remove aws-neuronx-gpsimd-customop-lib-0.* -y sudo yum install python3-devel -y sudo yum install aws-neuronx-gpsimd-tools-0.* -y sudo yum install aws-neuronx-gpsimd-customop-lib-0.* -y ``` On Ubuntu, they can be installed with the following commands: ``` sudo apt-get remove python3-dev -y sudo apt-get remove aws-neuronx-gpsimd-tools=0.* -y sudo apt-get remove aws-neuronx-gpsimd-customop-lib=0.* -y sudo apt-get install python3-dev -y sudo apt-get install aws-neuronx-gpsimd-tools=0.* -y sudo apt-get install aws-neuronx-gpsimd-customop-lib=0.* -y ``` For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands: ``` source ~/aws_neuron_venv_pytorch/bin/activate ``` Install dependencies for PyTorch Custom Extensions in your environment by running: ``` pip install regex pip install ninja ``` The `ninja` package is only needed for the reference CPU example. It is not needed by Neuron to run on Trainium instances. To download the source code for this tutorial, do: ``` git clone https://github.com/aws-neuron/aws-neuron-samples.git cd aws-neuron-samples/torch-neuronx/training/customop_mlp ``` In the `customop_mlp` directory there are two subdirectories. The `pytorch` directory contains an example model and training script using a custom operator that runs using the cpu device with standard PyTorch APIs and libraries (ie. not specific to AWS/Neuron). The `neuron` directory contains a version of the same model and training script with the custom operator ported to Neuron to run on trn1 using the XLA device. ## [Basic PyTorch Custom Relu Operator](#id2)[#](#basic-pytorch-custom-relu-operator "Permalink to this headline") For the next few sections we’ll review the example model in the `pytorch` directory. This is a condensed and simplified explanation of PyTorch C++ Extensions, for more details see the [PyTorch documentation](https://pytorch.org/tutorials/advanced/cpp_extension.html). In `my_ops.py` we implement a custom relu activation op as a torch autograd function so that we can use it in a training loop: ``` import torch torch.ops.load_library('librelu.so') class Relu(torch.autograd.Function): @staticmethod def forward(ctx, input): ctx.save_for_backward(input) return torch.ops.my_ops.relu_forward(input) @staticmethod def backward(ctx, grad): input, = ctx.saved_tensors return torch.ops.my_ops.relu_backward(grad, input), None ``` Notice that here we first load `librelu.so` using the `load_library` API. And then call the `relu_forward` and `relu_backward` functions from our library within the relevant static methods. We implemented these two library functions in the `relu.cpp` file: ``` torch::Tensor relu_forward(const torch::Tensor& t_in) { ... t_out_acc[i][j] = t_in_acc[i][j] > 0.0 ? t_in_acc[i][j] : 0.0; ... } torch::Tensor relu_backward(const torch::Tensor& t_grad, const torch::Tensor& t_in) { ... t_out_acc[i][j] = t_in_acc[i][j] > 0.0 ? t_grad_acc[i][j] : 0.0; ... } TORCH_LIBRARY(my_ops, m) { m.def("relu_forward", &relu_forward); m.def("relu_backward", &relu_backward); } ``` And then built them into a library using the PyTorch Cpp Extension APIs in the `build.py` script: ``` torch.utils.cpp_extension.load( name='librelu', sources=['relu.cpp'], is_python_module=False, build_directory=os.getcwd() ) ``` Run `python build.py` to produce the `librelu.so` library. ## [Multi-layer perceptron MNIST model](#id3)[#](#multi-layer-perceptron-mnist-model "Permalink to this headline") In `model.py`, we define the multi-layer perceptron (MLP) MNIST model with 3 linear layers and a custom ReLU activation, followed by a log-softmax layer. Highlighted below are the relevant custom changes in the `model.py` file: ``` import torch import torch.nn as nn from torch.nn import functional as F import my_ops # Declare 3-layer MLP for MNIST dataset class MLP(nn.Module): def __init__(self, input_size = 28 * 28, output_size = 10, layers = [120, 84]): super(MLP, self).__init__() self.fc1 = nn.Linear(input_size, layers[0]) self.fc2 = nn.Linear(layers[0], layers[1]) self.fc3 = nn.Linear(layers[1], output_size) def forward(self, x): f1 = self.fc1(x) r1 = my_ops.Relu.apply(f1) f2 = self.fc2(r1) r2 = my_ops.Relu.apply(f2) f3 = self.fc3(r2) return torch.log_softmax(f3, dim=1) ``` ## [Training the MLP model on CPU](#id4)[#](#training-the-mlp-model-on-cpu "Permalink to this headline") In the `train_cpu.py` script we load the MNIST train dataset, instantiate the MLP model, and use `device='cpu'` to execute on the host CPU. Expected CPU output: ``` ----------Training --------------- Train throughput *(*iter/sec*)*: *286*.96994718801335 Final loss is *0*.1040 ----------End Training --------------- ``` ## [Neuron Relu CustomOp](#id5)[#](#neuron-relu-customop "Permalink to this headline") Now switch over into the `neuron` directory. To migrate our PyTorch customOp to Neuron, we have to make a few small changes. First, we create a new `shape.cpp` file to implement our shape function as required by XLA (see [Neuron Custom C++ Operators Developer Guide \[Experimental\]](../programming-guide/custom-c%2B%2B-operators-devguide.html#feature-custom-operators-devguide) for details). We also replace the `TORCH_LIBRARY` API with `NEURON_LIBRARY`. ``` torch::Tensor relu_fwd_shape(torch::Tensor t_in) { torch::Tensor t_out = torch::zeros(t_in.sizes(), torch::kFloat); return t_out; } torch::Tensor relu_bwd_shape(torch::Tensor t_grad, torch::Tensor t_in) { torch::Tensor t_out = torch::zeros(t_in.sizes(), torch::kFloat); return t_out; } NEURON_LIBRARY(my_ops, m) { m.def("relu_forward", &relu_fwd_shape, "relu_forward"); m.def("relu_backward", &relu_bwd_shape, "relu_backward"); } ``` And then we build it using the `torch_neuronx` package in `build.py`: ``` from torch_neuronx.xla_impl import custom_op custom_op.load( name='relu', compute_srcs=['relu.cpp'], shape_srcs=['shape.cpp'], build_directory=os.getcwd() ) ``` Notice that here we specify both the `relu.cpp` and `shape.cpp` files separately. This is because the shape functions will be compiled with an x86 compiler and run on the host during the XLA compilation, and the compute functions will be compiled for the NeuronCore device and executed during the training loop. Running `build.py` produces the same `librelu.so` as in the CPU example, but compiles the source code to execute on the NeuronCore. In our `my_ops.py` file we just use the `torch_neuronx` API to load our new library and execute our customOp exactly the same way we did before: ``` import torch import torch_neuronx from torch_neuronx.xla_impl import custom_op custom_op.load_library('librelu.so') class Relu(torch.autograd.Function): @staticmethod def forward(ctx, input): ctx.save_for_backward(input) return torch.ops.my_ops.relu_forward(input) @staticmethod def backward(ctx, grad): input, = ctx.saved_tensors return torch.ops.my_ops.relu_backward(grad, input), None ``` ## [Training the MLP model on Trainium](#id6)[#](#training-the-mlp-model-on-trainium "Permalink to this headline") In the `train.py` script we modify the CPU training script `train_cpu.py` to run with PyTorch Neuron torch\_xla. Expected output on a trn1 instance: ``` ----------Training --------------- 2023-02-02 22 (tel:2023020222):46:58.000299: INFO ||NCC_WRAPPER||: Using a cached neff at /var/tmp/neuron-compile-cache/USER_neuroncc-2.0.0.8683a0+c94c3936c/MODULE_4447837791278761679/MODULE_0_SyncTensorsGraph.329_4447837791278761679_ip-172-31-38-167.us-west-2.compute.internal-49ad7ade-14011-5f3bf523d8788/1650ba41-bcfd-4d15-9038-16d391c4a57c/MODULE_0_SyncTensorsGraph.329_4447837791278761679_ip-172-31-38-167.us-west-2.compute.internal-49ad7ade-14011-5f3bf523d8788.neff. Exiting with a successfully compiled graph 2023-02-02 22 (tel:2023020222):46:58.000433: INFO ||NCC_WRAPPER||: Using a cached neff at /var/tmp/neuron-compile-cache/USER_neuroncc-2.0.0.8683a0+c94c3936c/MODULE_16964505026440903899/MODULE_1_SyncTensorsGraph.401_16964505026440903899_ip-172-31-38-167.us-west-2.compute.internal-4d0cabba-14011-5f3bf529794a3/23d74230-59dd-4347-b247-fa98aed416bd/MODULE_1_SyncTensorsGraph.401_16964505026440903899_ip-172-31-38-167.us-west-2.compute.internal-4d0cabba-14011-5f3bf529794a3.neff. Exiting with a successfully compiled graph Train throughput (iter/sec): 117.47151142662648 Final loss is 0.1970 ----------End Training --------------- ``` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Neuron Custom C++ Operators in MLP Training — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Neuron Custom C++ Operators Performance Optimization" href="customop-mlp-perf-opt.html"> <link rel="prev" title="Analyze for Training Tutorial" href="../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "neuron-customops/tutorials/customop-mlp-training", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> Neuron C++ Custom Operators </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2 has-children"> <a class="reference internal" href="../api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="tutorials.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active"> <a class="current reference internal" href="#"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fneuron-customops/tutorials/customop-mlp-training.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/neuron-customops/tutorials/customop-mlp-training.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/neuron-customops/tutorials/customop-mlp-training.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-environment-and-download-examples"> Setup Environment and Download Examples </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#basic-pytorch-custom-relu-operator"> Basic PyTorch Custom Relu Operator </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-layer-perceptron-mnist-model"> Multi-layer perceptron MNIST model </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#training-the-mlp-model-on-cpu"> Training the MLP model on CPU </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-relu-customop"> Neuron Relu CustomOp </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#training-the-mlp-model-on-trainium"> Training the MLP model on Trainium </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Neuron Custom C++ Operators in MLP Training</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup-environment-and-download-examples"> Setup Environment and Download Examples </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#basic-pytorch-custom-relu-operator"> Basic PyTorch Custom Relu Operator </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#multi-layer-perceptron-mnist-model"> Multi-layer perceptron MNIST model </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#training-the-mlp-model-on-cpu"> Training the MLP model on CPU </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-relu-customop"> Neuron Relu CustomOp </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#training-the-mlp-model-on-trainium"> Training the MLP model on Trainium </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="neuron-custom-c-operators-in-mlp-training"> <span id="neuronx-customop-mlp-tutorial"></span><h1>Neuron Custom C++ Operators in MLP Training<a class="headerlink" href="#neuron-custom-c-operators-in-mlp-training" title="Permalink to this headline">#</a></h1> <p>In this tutorial we’ll demonstrate how to prepare a PyTorch model that contains a custom operator (ie. CppExtension) for Neuron compilation to run on Trainium EC2 instances. To learn more about Neuron CustomOps see <a class="reference internal" href="../index.html#neuron-c-customops"><span class="std std-ref">Neuron Custom C++ Operators [Experimental]</span></a>. For a deeper dive on MNIST or Multi-Layer Perceptron models, see the <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html#neuronx-mlp-training-tutorial"><span class="std std-ref">Multi-Layer Perceptron Training Tutorial</span></a>. This tutorial assumes the reader is familiar with <a class="reference external" href="https://pytorch.org/tutorials/advanced/cpp_extension.html">PyTorch Custom Extensions</a>.</p> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#setup-environment-and-download-examples" id="id1">Setup Environment and Download Examples</a></p></li> <li><p><a class="reference internal" href="#basic-pytorch-custom-relu-operator" id="id2">Basic PyTorch Custom Relu Operator</a></p></li> <li><p><a class="reference internal" href="#multi-layer-perceptron-mnist-model" id="id3">Multi-layer perceptron MNIST model</a></p></li> <li><p><a class="reference internal" href="#training-the-mlp-model-on-cpu" id="id4">Training the MLP model on CPU</a></p></li> <li><p><a class="reference internal" href="#neuron-relu-customop" id="id5">Neuron Relu CustomOp</a></p></li> <li><p><a class="reference internal" href="#training-the-mlp-model-on-trainium" id="id6">Training the MLP model on Trainium</a></p></li> </ul> </div> <div class="section" id="setup-environment-and-download-examples"> <h2><a class="toc-backref" href="#id1">Setup Environment and Download Examples</a><a class="headerlink" href="#setup-environment-and-download-examples" title="Permalink to this headline">#</a></h2> <p>Before running the tutorial please follow the installation instructions at:</p> <ul class="simple"> <li><p><a class="reference internal" href="../../frameworks/torch/torch-neuronx/setup/pytorch-install.html#pytorch-neuronx-install"><span class="std std-ref">Install PyTorch Neuron (torch-neuronx)</span></a> on Trn1</p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The name of <code class="docutils literal notranslate"><span class="pre">aws-neuronx-gpsimd-customop</span></code> has been changed to <code class="docutils literal notranslate"><span class="pre">aws-neuronx-gpsimd-customop-lib</span></code> as of the neuron 2.10 release.</p> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Custom C++ Operators are supported as of Neuron SDK Version 2.7 as a beta feature. As such this feature is not installed by default. Additional tooling and library packages (RPM and DEB) are required. On AL2, they can be installed with the following commands:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="n">remove</span> <span class="n">python3</span><span class="o">-</span><span class="n">devel</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">remove</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">tools</span><span class="o">-</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">remove</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">customop</span><span class="o">-</span><span class="n">lib</span><span class="o">-</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">python3</span><span class="o">-</span><span class="n">devel</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">tools</span><span class="o">-</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">customop</span><span class="o">-</span><span class="n">lib</span><span class="o">-</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> </pre></div> </div> <p>On Ubuntu, they can be installed with the following commands:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">remove</span> <span class="n">python3</span><span class="o">-</span><span class="n">dev</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">remove</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">tools</span><span class="o">=</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">remove</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">customop</span><span class="o">-</span><span class="n">lib</span><span class="o">=</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">python3</span><span class="o">-</span><span class="n">dev</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">tools</span><span class="o">=</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">customop</span><span class="o">-</span><span class="n">lib</span><span class="o">=</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> </pre></div> </div> </div> <p>For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>~/aws_neuron_venv_pytorch/bin/activate </pre></div> </div> <p>Install dependencies for PyTorch Custom Extensions in your environment by running:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>regex pip<span class="w"> </span>install<span class="w"> </span>ninja </pre></div> </div> <p>The <code class="docutils literal notranslate"><span class="pre">ninja</span></code> package is only needed for the reference CPU example. It is not needed by Neuron to run on Trainium instances.</p> <p>To download the source code for this tutorial, do:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/aws-neuron/aws-neuron-samples.git <span class="nb">cd</span><span class="w"> </span>aws-neuron-samples/torch-neuronx/training/customop_mlp </pre></div> </div> <p>In the <code class="docutils literal notranslate"><span class="pre">customop_mlp</span></code> directory there are two subdirectories. The <code class="docutils literal notranslate"><span class="pre">pytorch</span></code> directory contains an example model and training script using a custom operator that runs using the cpu device with standard PyTorch APIs and libraries (ie. not specific to AWS/Neuron). The <code class="docutils literal notranslate"><span class="pre">neuron</span></code> directory contains a version of the same model and training script with the custom operator ported to Neuron to run on trn1 using the XLA device.</p> </div> <div class="section" id="basic-pytorch-custom-relu-operator"> <h2><a class="toc-backref" href="#id2">Basic PyTorch Custom Relu Operator</a><a class="headerlink" href="#basic-pytorch-custom-relu-operator" title="Permalink to this headline">#</a></h2> <p>For the next few sections we’ll review the example model in the <code class="docutils literal notranslate"><span class="pre">pytorch</span></code> directory. This is a condensed and simplified explanation of PyTorch C++ Extensions, for more details see the <a class="reference external" href="https://pytorch.org/tutorials/advanced/cpp_extension.html">PyTorch documentation</a>. In <code class="docutils literal notranslate"><span class="pre">my_ops.py</span></code> we implement a custom relu activation op as a torch autograd function so that we can use it in a training loop:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="n">torch</span><span class="o">.</span><span class="n">ops</span><span class="o">.</span><span class="n">load_library</span><span class="p">(</span><span class="s1">'librelu.so'</span><span class="p">)</span> <span class="k">class</span> <span class="nc">Relu</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">autograd</span><span class="o">.</span><span class="n">Function</span><span class="p">):</span> <span class="nd">@staticmethod</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="nb">input</span><span class="p">):</span> <span class="n">ctx</span><span class="o">.</span><span class="n">save_for_backward</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span> <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">ops</span><span class="o">.</span><span class="n">my_ops</span><span class="o">.</span><span class="n">relu_forward</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span> <span class="nd">@staticmethod</span> <span class="k">def</span> <span class="nf">backward</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">grad</span><span class="p">):</span> <span class="nb">input</span><span class="p">,</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">saved_tensors</span> <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">ops</span><span class="o">.</span><span class="n">my_ops</span><span class="o">.</span><span class="n">relu_backward</span><span class="p">(</span><span class="n">grad</span><span class="p">,</span> <span class="nb">input</span><span class="p">),</span> <span class="kc">None</span> </pre></div> </div> <p>Notice that here we first load <code class="docutils literal notranslate"><span class="pre">librelu.so</span></code> using the <code class="docutils literal notranslate"><span class="pre">load_library</span></code> API. And then call the <code class="docutils literal notranslate"><span class="pre">relu_forward</span></code> and <code class="docutils literal notranslate"><span class="pre">relu_backward</span></code> functions from our library within the relevant static methods.</p> <p>We implemented these two library functions in the <code class="docutils literal notranslate"><span class="pre">relu.cpp</span></code> file:</p> <div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="nf">relu_forward</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="o">&amp;</span><span class="w"> </span><span class="n">t_in</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="p">...</span> <span class="w"> </span><span class="n">t_out_acc</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">t_in_acc</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="mf">0.0</span><span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="n">t_in_acc</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="mf">0.0</span><span class="p">;</span> <span class="w"> </span><span class="p">...</span> <span class="p">}</span> <span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="nf">relu_backward</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="o">&amp;</span><span class="w"> </span><span class="n">t_grad</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="o">&amp;</span><span class="w"> </span><span class="n">t_in</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="p">...</span> <span class="w"> </span><span class="n">t_out_acc</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">t_in_acc</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="mf">0.0</span><span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="n">t_grad_acc</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="mf">0.0</span><span class="p">;</span> <span class="w"> </span><span class="p">...</span> <span class="p">}</span> <span class="n">TORCH_LIBRARY</span><span class="p">(</span><span class="n">my_ops</span><span class="p">,</span><span class="w"> </span><span class="n">m</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="n">m</span><span class="p">.</span><span class="n">def</span><span class="p">(</span><span class="s">"relu_forward"</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">relu_forward</span><span class="p">);</span> <span class="w"> </span><span class="n">m</span><span class="p">.</span><span class="n">def</span><span class="p">(</span><span class="s">"relu_backward"</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">relu_backward</span><span class="p">);</span> <span class="p">}</span> </pre></div> </div> <p>And then built them into a library using the PyTorch Cpp Extension APIs in the <code class="docutils literal notranslate"><span class="pre">build.py</span></code> script:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">torch</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">cpp_extension</span><span class="o">.</span><span class="n">load</span><span class="p">(</span> <span class="n">name</span><span class="o">=</span><span class="s1">'librelu'</span><span class="p">,</span> <span class="n">sources</span><span class="o">=</span><span class="p">[</span><span class="s1">'relu.cpp'</span><span class="p">],</span> <span class="n">is_python_module</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">build_directory</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span> <span class="p">)</span> </pre></div> </div> <p>Run <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">build.py</span></code> to produce the <code class="docutils literal notranslate"><span class="pre">librelu.so</span></code> library.</p> </div> <div class="section" id="multi-layer-perceptron-mnist-model"> <h2><a class="toc-backref" href="#id3">Multi-layer perceptron MNIST model</a><a class="headerlink" href="#multi-layer-perceptron-mnist-model" title="Permalink to this headline">#</a></h2> <p>In <code class="docutils literal notranslate"><span class="pre">model.py</span></code>, we define the multi-layer perceptron (MLP) MNIST model with 3 linear layers and a custom ReLU activation, followed by a log-softmax layer. Highlighted below are the relevant custom changes in the <code class="docutils literal notranslate"><span class="pre">model.py</span></code> file:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="kn">from</span> <span class="nn">torch.nn</span> <span class="kn">import</span> <span class="n">functional</span> <span class="k">as</span> <span class="n">F</span> <span class="hll"><span class="kn">import</span> <span class="nn">my_ops</span> </span> <span class="c1"># Declare 3-layer MLP for MNIST dataset</span> <span class="k">class</span> <span class="nc">MLP</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">input_size</span> <span class="o">=</span> <span class="mi">28</span> <span class="o">*</span> <span class="mi">28</span><span class="p">,</span> <span class="n">output_size</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span> <span class="n">layers</span> <span class="o">=</span> <span class="p">[</span><span class="mi">120</span><span class="p">,</span> <span class="mi">84</span><span class="p">]):</span> <span class="nb">super</span><span class="p">(</span><span class="n">MLP</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc1</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">input_size</span><span class="p">,</span> <span class="n">layers</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc2</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">layers</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">layers</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc3</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">layers</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">output_size</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="n">f1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc1</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="hll"> <span class="n">r1</span> <span class="o">=</span> <span class="n">my_ops</span><span class="o">.</span><span class="n">Relu</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">f1</span><span class="p">)</span> </span> <span class="n">f2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc2</span><span class="p">(</span><span class="n">r1</span><span class="p">)</span> <span class="hll"> <span class="n">r2</span> <span class="o">=</span> <span class="n">my_ops</span><span class="o">.</span><span class="n">Relu</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">f2</span><span class="p">)</span> </span> <span class="n">f3</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc3</span><span class="p">(</span><span class="n">r2</span><span class="p">)</span> <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">log_softmax</span><span class="p">(</span><span class="n">f3</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="training-the-mlp-model-on-cpu"> <h2><a class="toc-backref" href="#id4">Training the MLP model on CPU</a><a class="headerlink" href="#training-the-mlp-model-on-cpu" title="Permalink to this headline">#</a></h2> <p>In the <code class="docutils literal notranslate"><span class="pre">train_cpu.py</span></code> script we load the MNIST train dataset, instantiate the MLP model, and use <code class="docutils literal notranslate"><span class="pre">device='cpu'</span></code> to execute on the host CPU. Expected CPU output:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>----------Training<span class="w"> </span>--------------- Train<span class="w"> </span>throughput<span class="w"> </span>*<span class="o">(</span>*iter/sec*<span class="o">)</span>*:<span class="w"> </span>*286*.96994718801335 Final<span class="w"> </span>loss<span class="w"> </span>is<span class="w"> </span>*0*.1040 ----------End<span class="w"> </span>Training<span class="w"> </span>--------------- </pre></div> </div> </div> <div class="section" id="neuron-relu-customop"> <h2><a class="toc-backref" href="#id5">Neuron Relu CustomOp</a><a class="headerlink" href="#neuron-relu-customop" title="Permalink to this headline">#</a></h2> <p>Now switch over into the <code class="docutils literal notranslate"><span class="pre">neuron</span></code> directory. To migrate our PyTorch customOp to Neuron, we have to make a few small changes. First, we create a new <code class="docutils literal notranslate"><span class="pre">shape.cpp</span></code> file to implement our shape function as required by XLA (see <a class="reference internal" href="../programming-guide/custom-c%2B%2B-operators-devguide.html#feature-custom-operators-devguide"><span class="std std-ref">Neuron Custom C++ Operators Developer Guide [Experimental]</span></a> for details). We also replace the <code class="docutils literal notranslate"><span class="pre">TORCH_LIBRARY</span></code> API with <code class="docutils literal notranslate"><span class="pre">NEURON_LIBRARY</span></code>.</p> <div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="nf">relu_fwd_shape</span><span class="p">(</span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="n">t_in</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="n">t_out</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">zeros</span><span class="p">(</span><span class="n">t_in</span><span class="p">.</span><span class="n">sizes</span><span class="p">(),</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">kFloat</span><span class="p">);</span> <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">t_out</span><span class="p">;</span> <span class="p">}</span> <span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="nf">relu_bwd_shape</span><span class="p">(</span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="n">t_grad</span><span class="p">,</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="n">t_in</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="n">t_out</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">zeros</span><span class="p">(</span><span class="n">t_in</span><span class="p">.</span><span class="n">sizes</span><span class="p">(),</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">kFloat</span><span class="p">);</span> <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">t_out</span><span class="p">;</span> <span class="p">}</span> <span class="n">NEURON_LIBRARY</span><span class="p">(</span><span class="n">my_ops</span><span class="p">,</span><span class="w"> </span><span class="n">m</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="n">m</span><span class="p">.</span><span class="n">def</span><span class="p">(</span><span class="s">"relu_forward"</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">relu_fwd_shape</span><span class="p">,</span><span class="w"> </span><span class="s">"relu_forward"</span><span class="p">);</span> <span class="w"> </span><span class="n">m</span><span class="p">.</span><span class="n">def</span><span class="p">(</span><span class="s">"relu_backward"</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">relu_bwd_shape</span><span class="p">,</span><span class="w"> </span><span class="s">"relu_backward"</span><span class="p">);</span> <span class="p">}</span> </pre></div> </div> <p>And then we build it using the <code class="docutils literal notranslate"><span class="pre">torch_neuronx</span></code> package in <code class="docutils literal notranslate"><span class="pre">build.py</span></code>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">torch_neuronx.xla_impl</span> <span class="kn">import</span> <span class="n">custom_op</span> <span class="n">custom_op</span><span class="o">.</span><span class="n">load</span><span class="p">(</span> <span class="n">name</span><span class="o">=</span><span class="s1">'relu'</span><span class="p">,</span> <span class="n">compute_srcs</span><span class="o">=</span><span class="p">[</span><span class="s1">'relu.cpp'</span><span class="p">],</span> <span class="n">shape_srcs</span><span class="o">=</span><span class="p">[</span><span class="s1">'shape.cpp'</span><span class="p">],</span> <span class="n">build_directory</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span> <span class="p">)</span> </pre></div> </div> <p>Notice that here we specify both the <code class="docutils literal notranslate"><span class="pre">relu.cpp</span></code> and <code class="docutils literal notranslate"><span class="pre">shape.cpp</span></code> files separately. This is because the shape functions will be compiled with an x86 compiler and run on the host during the XLA compilation, and the compute functions will be compiled for the NeuronCore device and executed during the training loop. Running <code class="docutils literal notranslate"><span class="pre">build.py</span></code> produces the same <code class="docutils literal notranslate"><span class="pre">librelu.so</span></code> as in the CPU example, but compiles the source code to execute on the NeuronCore.</p> <p>In our <code class="docutils literal notranslate"><span class="pre">my_ops.py</span></code> file we just use the <code class="docutils literal notranslate"><span class="pre">torch_neuronx</span></code> API to load our new library and execute our customOp exactly the same way we did before:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torch_neuronx.xla_impl</span> <span class="kn">import</span> <span class="n">custom_op</span> <span class="n">custom_op</span><span class="o">.</span><span class="n">load_library</span><span class="p">(</span><span class="s1">'librelu.so'</span><span class="p">)</span> <span class="k">class</span> <span class="nc">Relu</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">autograd</span><span class="o">.</span><span class="n">Function</span><span class="p">):</span> <span class="nd">@staticmethod</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="nb">input</span><span class="p">):</span> <span class="n">ctx</span><span class="o">.</span><span class="n">save_for_backward</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span> <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">ops</span><span class="o">.</span><span class="n">my_ops</span><span class="o">.</span><span class="n">relu_forward</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span> <span class="nd">@staticmethod</span> <span class="k">def</span> <span class="nf">backward</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">grad</span><span class="p">):</span> <span class="nb">input</span><span class="p">,</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">saved_tensors</span> <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">ops</span><span class="o">.</span><span class="n">my_ops</span><span class="o">.</span><span class="n">relu_backward</span><span class="p">(</span><span class="n">grad</span><span class="p">,</span> <span class="nb">input</span><span class="p">),</span> <span class="kc">None</span> </pre></div> </div> </div> <div class="section" id="training-the-mlp-model-on-trainium"> <h2><a class="toc-backref" href="#id6">Training the MLP model on Trainium</a><a class="headerlink" href="#training-the-mlp-model-on-trainium" title="Permalink to this headline">#</a></h2> <p>In the <code class="docutils literal notranslate"><span class="pre">train.py</span></code> script we modify the CPU training script <code class="docutils literal notranslate"><span class="pre">train_cpu.py</span></code> to run with PyTorch Neuron torch_xla. Expected output on a trn1 instance:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>----------Training<span class="w"> </span>--------------- <span class="m">2023</span>-02-02<span class="w"> </span><span class="m">22</span><span class="w"> </span><span class="o">(</span>tel:2023020222<span class="o">)</span>:46:58.000299:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Using<span class="w"> </span>a<span class="w"> </span>cached<span class="w"> </span>neff<span class="w"> </span>at<span class="w"> </span>/var/tmp/neuron-compile-cache/USER_neuroncc-2.0.0.8683a0+c94c3936c/MODULE_4447837791278761679/MODULE_0_SyncTensorsGraph.329_4447837791278761679_ip-172-31-38-167.us-west-2.compute.internal-49ad7ade-14011-5f3bf523d8788/1650ba41-bcfd-4d15-9038-16d391c4a57c/MODULE_0_SyncTensorsGraph.329_4447837791278761679_ip-172-31-38-167.us-west-2.compute.internal-49ad7ade-14011-5f3bf523d8788.neff.<span class="w"> </span>Exiting<span class="w"> </span>with<span class="w"> </span>a<span class="w"> </span>successfully<span class="w"> </span>compiled<span class="w"> </span>graph <span class="m">2023</span>-02-02<span class="w"> </span><span class="m">22</span><span class="w"> </span><span class="o">(</span>tel:2023020222<span class="o">)</span>:46:58.000433:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Using<span class="w"> </span>a<span class="w"> </span>cached<span class="w"> </span>neff<span class="w"> </span>at<span class="w"> </span>/var/tmp/neuron-compile-cache/USER_neuroncc-2.0.0.8683a0+c94c3936c/MODULE_16964505026440903899/MODULE_1_SyncTensorsGraph.401_16964505026440903899_ip-172-31-38-167.us-west-2.compute.internal-4d0cabba-14011-5f3bf529794a3/23d74230-59dd-4347-b247-fa98aed416bd/MODULE_1_SyncTensorsGraph.401_16964505026440903899_ip-172-31-38-167.us-west-2.compute.internal-4d0cabba-14011-5f3bf529794a3.neff.<span class="w"> </span>Exiting<span class="w"> </span>with<span class="w"> </span>a<span class="w"> </span>successfully<span class="w"> </span>compiled<span class="w"> </span>graph Train<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">117</span>.47151142662648 Final<span class="w"> </span>loss<span class="w"> </span>is<span class="w"> </span><span class="m">0</span>.1970 ----------End<span class="w"> </span>Training<span class="w"> </span>--------------- </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Analyze for Training Tutorial</p> </div> </a> <a class="right-next" id="next-link" href="customop-mlp-perf-opt.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Neuron Custom C++ Operators Performance Optimization</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:06.377Z
ZeRO-1 Tutorial — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html
# ZeRO-1 Tutorial — AWS Neuron Documentation ## Contents - [What is ZeRO-1?](#what-is-zero-1) - [Usage](#usage) - [GPT2-XL Pretraining Tutorial](#gpt2-xl-pretraining-tutorial) - [Setup](#setup) - [Dataset](#dataset) - [Training](#training) - [Known Issues, **Work-arounds and Limitations**](#known-issues-work-arounds-and-limitations) _This document is relevant for_: `Trn1`, `Trn1n` ## ZeRO-1 Tutorial[#](#zero-1-tutorial "Permalink to this headline") ## What is ZeRO-1?[#](#what-is-zero-1 "Permalink to this headline") ZeRO-1 (Zero Redundancy Optimizer Stage 1, [https://arxiv.org/abs/1910.02054](https://arxiv.org/abs/1910.02054)) is an optimization technique for large-scale deep learning models. It is a memory efficient variation of data parallelism. ZeRO leverages the aggregate computation and memory resources of data parallelism to reduce the memory and compute requirements of each accelerator used for model training. ZeRO reduces the memory consumption of each accelerator by partitioning the various model training states (weights, gradients, and optimizer states) across the available devices in the distributed training hardware. ZeRO is being implemented as incremental stages of optimizations. In stage 1, the optimizer states (e.g., for Adam optimizer, 32-bit weights, and the first, and second moment estimates) are partitioned across the processes, so that each process updates only its partition. ![Image: zero1.jpg](../../../../../_images/zero1.jpg) We implemented an XLA-friendly version of ZeRO-1 and it has been merged in open-source PyTorch/XLA project. Users can use it to enable ZeRO-1 algorithm by simply wrapping the origin optimizer as shown below. ``` # Before: optimizer = torch.optim.Adam(model.parameters(), lr=0.0001) # After optimizer = ZeroRedundancyOptimizer(model.parameters(), torch.optim.Adam, lr=0.0001) ``` Then just call `optimizer.step()` directly, the wrapped optimizer will handle the distributed operations automatically. The above code snippet illustrates the basic usage. Generally, users can use ZeRO-1 optimizer like a normal optimizer. In addition, `ZeroRedundancyOptimizer` also provides other features: enable gradient clipping or use other data type for wrapped optimizer. Note that though the most of optimizers can be used with ZeRO-1, optimizers that compute norm for parameters (e.g. LAMB) might lead to accuracy disparities compared to using original local optimizer when using ZeRO-1, because these optimizers cannot get full parameters but shards. ## Usage[#](#usage "Permalink to this headline") To enable ZeRO-1 optimizer, just import it and replace origin optimizer with ZeRO-1 wrapped version ``` from torch_xla.distributed.zero_redundancy_optimizer import ZeroRedundancyOptimizer ... ... device = xm.xla_device() model = model.to(device) optimizer = ZeroRedundancyOptimizer(model.parameters(), AdamW, lr=0.001) ``` Then in training loop, just call `optimizer.step()` , note that we should not use `xm.reduce_gradients()` or `xm.optimizer_step()` as gradient reduction will be handle by ZeRO-1. ``` ... loss.backward() xm**.**mark_step**()** optimizer.step() xm**.**mark_step**()** ``` ZeRO-1 optimizer also provides some additional features, user can pass these arguments to the wrapper constructor: - change `optimizer_dtype` to choose data used by optimizer, default is `torch.float32` - change `grad_clipping` to enable grad clipping, default is true - change `max_norm` to determine the maximum norm value used by grad clipping, default is 1.0 ## GPT2-XL Pretraining Tutorial[#](#gpt2-xl-pretraining-tutorial "Permalink to this headline") Table of Contents: - Setup - Dataset - Training --- ### Setup[#](#setup "Permalink to this headline") We use single Trn1.32xlarge instance. Follow [Install PyTorch Neuron on Trn1](../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx) to setup the environment first. For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands: **requirements.txt:** We pin the following Hugging Face Library versions necessary for the tutorial ``` transformers==4.27.3 accelerate==0.17 datasets==2.10.1 tensorboard==2.12.2 ``` ``` source ~/aws_neuron_venv_pytorch/bin/activate ``` ``` git clone https://github.com/aws-neuron/aws-neuron-samples.git cd aws-neuron-samples/torch-neuronx/training/zero1_gpt2 python3 -m pip install -r requirements.txt ``` The specific files you need for this tutorial: - config\_1p5B\_gpt2.json: The model configuration used in the tutorial for GPT 2.7B Neo - neuron\_utils.py: includes utility functions and the logging tools - run\_clm\_no\_trainer.py: the main training script that runs the actual training - run\_clm.sh: the shell script to launch the training job ### Dataset[#](#dataset "Permalink to this headline") For the dataset, we use the wikitext dataset, specifically `wikitext-103-raw-v1,` provided by the HuggingFace [https://huggingface.co/datasets/wikitext](https://huggingface.co/datasets/wikitext). The data will be preprocessed the first time running through the training script and then preprocessed data will be cached in the HuggingFace cache directory for any future training runs. If the main process downloads the dataset, tokenizes the data and groups them together successfully, the expected output would be as below at the beginning of the training. ``` ***** Running training ***** Num examples = 114248 Num Epochs = 29 Instantaneous batch size per device = 1 Total train batch size (w. parallel, distributed & accumulation) = 32 Gradient Accumulation steps = 1 Total optimization steps = 100000 ``` ### Training[#](#training "Permalink to this headline") The GPT2 python fine-tuning script is adapted from the example [run\_clm\_no\_trainer.py](https://github.com/huggingface/transformers/blob/main/examples/pytorch/language-modeling/run_clm_no_trainer.py) in [https://github.com/huggingface/transformers/tree/main/examples/pytorch/language-modeling](https://github.com/huggingface/transformers/tree/main/examples/pytorch/language-modeling). It incorporates the Accelerate [https://github.com/huggingface/accelerate](https://github.com/huggingface/accelerate). Given its experimental stage, some modifications are needed, along with the bridge code to XLA. Particularly, some workarounds to support Accelerate for the training script are listed in “Known Issues Workarounds and Limitations” below. In this example, we use GPT2-xl as example, and show the training steps with mixed precision (bfloat16 and float32) - single node training: ``` # compile graphs neuron_parallel_compile bash run_clm.sh MIXED wikitext-103-raw-v1 bash run_clm.sh MIXED wikitext-103-raw-v1 ``` - multi-node training, run: ``` sbatch run_clm_compile.slurm ``` then ### Known Issues, **Work-arounds and Limitations**[#](#known-issues-work-arounds-and-limitations "Permalink to this headline") 1. Activation checkpointing + Custom FAL Dropout: We have implemented a version of dropout that caches the masks obtained during the first forward pass which will be reused again during the forward pass when activation checkpointing is enabled. All the scripts have the following flag turned on: export NEURON\_ENABLE\_NOSEED\_DROPOUT=1. 2. Error message: `ValueError: invalid literal for int() with base 10: ''`. Simply re-run the script can solve this issue. This issue is already solved in the newer versions of transformers, see [https://github.com/huggingface/transformers/pull/22427](https://github.com/huggingface/transformers/pull/22427). 3. Accelerator API workarounds: - Error message: “Gradient accumulation is not supported on TPU. Please set gradient\_accumulation\_steps to 1 and don’t pass in a GradientAccumulationPlugin object.” More context here: [https://github.com/huggingface/accelerate/pull/479](https://github.com/huggingface/accelerate/pull/479). The training still works by commenting out the assertion and avoid using the accumulation wrapper with accelerator.accumulate(model) - Accelerator.prepare call: We have noticed that using the optimizer returned by this API are not directly reusable. It is due to gaps in configuring accelerate API for XLA devices. _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>ZeRO-1 Tutorial — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Analyze for Training Tutorial" href="analyze_for_training.html"> <link rel="prev" title="Fine-tune T5 model on Trn1" href="finetune_t5.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-training-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#what-is-zero-1"> What is ZeRO-1? </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#usage"> Usage </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#gpt2-xl-pretraining-tutorial"> GPT2-XL Pretraining Tutorial </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup"> Setup </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataset"> Dataset </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#training"> Training </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-work-arounds-and-limitations"> Known Issues, <strong> Work-arounds and Limitations </strong> </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>ZeRO-1 Tutorial</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#what-is-zero-1"> What is ZeRO-1? </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#usage"> Usage </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#gpt2-xl-pretraining-tutorial"> GPT2-XL Pretraining Tutorial </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup"> Setup </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dataset"> Dataset </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#training"> Training </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-work-arounds-and-limitations"> Known Issues, <strong> Work-arounds and Limitations </strong> </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="zero-1-tutorial"> <span id="zero1-gpt2-pretraining-tutorial"></span><h1>ZeRO-1 Tutorial<a class="headerlink" href="#zero-1-tutorial" title="Permalink to this headline">#</a></h1> <div class="section" id="what-is-zero-1"> <h2>What is ZeRO-1?<a class="headerlink" href="#what-is-zero-1" title="Permalink to this headline">#</a></h2> <p>ZeRO-1 (Zero Redundancy Optimizer Stage 1, <a class="reference external" href="https://arxiv.org/abs/1910.02054">https://arxiv.org/abs/1910.02054</a>) is an optimization technique for large-scale deep learning models. It is a memory efficient variation of data parallelism. ZeRO leverages the aggregate computation and memory resources of data parallelism to reduce the memory and compute requirements of each accelerator used for model training. ZeRO reduces the memory consumption of each accelerator by partitioning the various model training states (weights, gradients, and optimizer states) across the available devices in the distributed training hardware. ZeRO is being implemented as incremental stages of optimizations. In stage 1, the optimizer states (e.g., for Adam optimizer, 32-bit weights, and the first, and second moment estimates) are partitioned across the processes, so that each process updates only its partition.</p> <img alt="Image: zero1.jpg" src="../../../../../_images/zero1.jpg"> <p>We implemented an XLA-friendly version of ZeRO-1 and it has been merged in open-source PyTorch/XLA project. Users can use it to enable ZeRO-1 algorithm by simply wrapping the origin optimizer as shown below.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Before:</span> <span class="n">optimizer</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">optim</span><span class="o">.</span><span class="n">Adam</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">parameters</span><span class="p">(),</span> <span class="n">lr</span><span class="o">=</span><span class="mf">0.0001</span><span class="p">)</span> <span class="c1"># After</span> <span class="n">optimizer</span> <span class="o">=</span> <span class="n">ZeroRedundancyOptimizer</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">parameters</span><span class="p">(),</span> <span class="n">torch</span><span class="o">.</span><span class="n">optim</span><span class="o">.</span><span class="n">Adam</span><span class="p">,</span> <span class="n">lr</span><span class="o">=</span><span class="mf">0.0001</span><span class="p">)</span> </pre></div> </div> <p>Then just call <code class="docutils literal notranslate"><span class="pre">optimizer.step()</span></code> directly, the wrapped optimizer will handle the distributed operations automatically.</p> <p>The above code snippet illustrates the basic usage. Generally, users can use ZeRO-1 optimizer like a normal optimizer. In addition, <code class="docutils literal notranslate"><span class="pre">ZeroRedundancyOptimizer</span></code> also provides other features: enable gradient clipping or use other data type for wrapped optimizer. Note that though the most of optimizers can be used with ZeRO-1, optimizers that compute norm for parameters (e.g. LAMB) might lead to accuracy disparities compared to using original local optimizer when using ZeRO-1, because these optimizers cannot get full parameters but shards.</p> </div> <div class="section" id="usage"> <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">#</a></h2> <p>To enable ZeRO-1 optimizer, just import it and replace origin optimizer with ZeRO-1 wrapped version</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">torch_xla.distributed.zero_redundancy_optimizer</span> <span class="kn">import</span> <span class="n">ZeroRedundancyOptimizer</span> <span class="o">...</span> <span class="o">...</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="n">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">optimizer</span> <span class="o">=</span> <span class="n">ZeroRedundancyOptimizer</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">parameters</span><span class="p">(),</span> <span class="n">AdamW</span><span class="p">,</span> <span class="n">lr</span><span class="o">=</span><span class="mf">0.001</span><span class="p">)</span> </pre></div> </div> <p>Then in training loop, just call <code class="docutils literal notranslate"><span class="pre">optimizer.step()</span></code> , note that we should not use <code class="docutils literal notranslate"><span class="pre">xm.reduce_gradients()</span></code> or <code class="docutils literal notranslate"><span class="pre">xm.optimizer_step()</span></code> as gradient reduction will be handle by ZeRO-1.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="n">loss</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span> <span class="n">xm</span><span class="o">**.**</span><span class="n">mark_step</span><span class="o">**</span><span class="p">()</span><span class="o">**</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">step</span><span class="p">()</span> <span class="n">xm</span><span class="o">**.**</span><span class="n">mark_step</span><span class="o">**</span><span class="p">()</span><span class="o">**</span> </pre></div> </div> <p>ZeRO-1 optimizer also provides some additional features, user can pass these arguments to the wrapper constructor:</p> <ul class="simple"> <li><p>change <code class="docutils literal notranslate"><span class="pre">optimizer_dtype</span></code> to choose data used by optimizer, default is <code class="docutils literal notranslate"><span class="pre">torch.float32</span></code></p></li> <li><p>change <code class="docutils literal notranslate"><span class="pre">grad_clipping</span></code> to enable grad clipping, default is true</p></li> <li><p>change <code class="docutils literal notranslate"><span class="pre">max_norm</span></code> to determine the maximum norm value used by grad clipping, default is 1.0</p></li> </ul> </div> <div class="section" id="gpt2-xl-pretraining-tutorial"> <h2>GPT2-XL Pretraining Tutorial<a class="headerlink" href="#gpt2-xl-pretraining-tutorial" title="Permalink to this headline">#</a></h2> <p>Table of Contents:</p> <ul class="simple"> <li><p>Setup</p></li> <li><p>Dataset</p></li> <li><p>Training</p></li> </ul> <hr class="docutils"> <div class="section" id="setup"> <h3>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">#</a></h3> <p>We use single Trn1.32xlarge instance. Follow <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html#setup-torch-neuronx"><span class="std std-ref">Install PyTorch Neuron on Trn1</span></a> to setup the environment first. For all the commands below, make sure you are in the virtual environment that you have created above before you run the commands:</p> <p><strong>requirements.txt:</strong> We pin the following Hugging Face Library versions necessary for the tutorial</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">transformers</span><span class="o">==</span><span class="mf">4.27.3</span> <span class="n">accelerate</span><span class="o">==</span><span class="mf">0.17</span> <span class="n">datasets</span><span class="o">==</span><span class="mf">2.10.1</span> <span class="n">tensorboard</span><span class="o">==</span><span class="mf">2.12.2</span> </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">source</span> <span class="o">~/</span><span class="n">aws_neuron_venv_pytorch</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span> </pre></div> </div> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">aws</span><span class="o">-</span><span class="n">neuron</span><span class="o">/</span><span class="n">aws</span><span class="o">-</span><span class="n">neuron</span><span class="o">-</span><span class="n">samples</span><span class="o">.</span><span class="n">git</span> <span class="n">cd</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuron</span><span class="o">-</span><span class="n">samples</span><span class="o">/</span><span class="n">torch</span><span class="o">-</span><span class="n">neuronx</span><span class="o">/</span><span class="n">training</span><span class="o">/</span><span class="n">zero1_gpt2</span> <span class="n">python3</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span> </pre></div> </div> <p>The specific files you need for this tutorial:</p> <ul class="simple"> <li><p>config_1p5B_gpt2.json: The model configuration used in the tutorial for GPT 2.7B Neo</p></li> <li><p>neuron_utils.py: includes utility functions and the logging tools</p></li> <li><p>run_clm_no_trainer.py: the main training script that runs the actual training</p></li> <li><p>run_clm.sh: the shell script to launch the training job</p></li> </ul> </div> <div class="section" id="dataset"> <h3>Dataset<a class="headerlink" href="#dataset" title="Permalink to this headline">#</a></h3> <p>For the dataset, we use the wikitext dataset, specifically <code class="docutils literal notranslate"><span class="pre">wikitext-103-raw-v1,</span></code> provided by the HuggingFace <a class="reference external" href="https://huggingface.co/datasets/wikitext">https://huggingface.co/datasets/wikitext</a>. The data will be preprocessed the first time running through the training script and then preprocessed data will be cached in the HuggingFace cache directory for any future training runs.</p> <p>If the main process downloads the dataset, tokenizes the data and groups them together successfully, the expected output would be as below at the beginning of the training.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">*****</span> <span class="n">Running</span> <span class="n">training</span> <span class="o">*****</span> <span class="n">Num</span> <span class="n">examples</span> <span class="o">=</span> <span class="mi">114248</span> <span class="n">Num</span> <span class="n">Epochs</span> <span class="o">=</span> <span class="mi">29</span> <span class="n">Instantaneous</span> <span class="n">batch</span> <span class="n">size</span> <span class="n">per</span> <span class="n">device</span> <span class="o">=</span> <span class="mi">1</span> <span class="n">Total</span> <span class="n">train</span> <span class="n">batch</span> <span class="n">size</span> <span class="p">(</span><span class="n">w</span><span class="o">.</span> <span class="n">parallel</span><span class="p">,</span> <span class="n">distributed</span> <span class="o">&amp;</span> <span class="n">accumulation</span><span class="p">)</span> <span class="o">=</span> <span class="mi">32</span> <span class="n">Gradient</span> <span class="n">Accumulation</span> <span class="n">steps</span> <span class="o">=</span> <span class="mi">1</span> <span class="n">Total</span> <span class="n">optimization</span> <span class="n">steps</span> <span class="o">=</span> <span class="mi">100000</span> </pre></div> </div> </div> <div class="section" id="training"> <h3>Training<a class="headerlink" href="#training" title="Permalink to this headline">#</a></h3> <p>The GPT2 python fine-tuning script is adapted from the example <a class="reference external" href="https://github.com/huggingface/transformers/blob/main/examples/pytorch/language-modeling/run_clm_no_trainer.py">run_clm_no_trainer.py</a> in <a class="reference external" href="https://github.com/huggingface/transformers/tree/main/examples/pytorch/language-modeling">https://github.com/huggingface/transformers/tree/main/examples/pytorch/language-modeling</a>. It incorporates the Accelerate <a class="reference external" href="https://github.com/huggingface/accelerate">https://github.com/huggingface/accelerate</a>. Given its experimental stage, some modifications are needed, along with the bridge code to XLA. Particularly, some workarounds to support Accelerate for the training script are listed in “Known Issues Workarounds and Limitations” below.</p> <p>In this example, we use GPT2-xl as example, and show the training steps with mixed precision (bfloat16 and float32)</p> <ul class="simple"> <li><p>single node training:</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># compile graphs</span> <span class="n">neuron_parallel_compile</span> <span class="n">bash</span> <span class="n">run_clm</span><span class="o">.</span><span class="n">sh</span> <span class="n">MIXED</span> <span class="n">wikitext</span><span class="o">-</span><span class="mi">103</span><span class="o">-</span><span class="n">raw</span><span class="o">-</span><span class="n">v1</span> <span class="n">bash</span> <span class="n">run_clm</span><span class="o">.</span><span class="n">sh</span> <span class="n">MIXED</span> <span class="n">wikitext</span><span class="o">-</span><span class="mi">103</span><span class="o">-</span><span class="n">raw</span><span class="o">-</span><span class="n">v1</span> </pre></div> </div> <ul class="simple"> <li><p>multi-node training, run:</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sbatch</span> <span class="n">run_clm_compile</span><span class="o">.</span><span class="n">slurm</span> </pre></div> </div> <p>then</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sbatch</span> <span class="n">run_clm</span><span class="o">.</span><span class="n">slurm</span> </pre></div> </div> </div> <div class="section" id="known-issues-work-arounds-and-limitations"> <h3>Known Issues, <strong>Work-arounds and Limitations</strong><a class="headerlink" href="#known-issues-work-arounds-and-limitations" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Activation checkpointing + Custom FAL Dropout: We have implemented a version of dropout that caches the masks obtained during the first forward pass which will be reused again during the forward pass when activation checkpointing is enabled. All the scripts have the following flag turned on: export NEURON_ENABLE_NOSEED_DROPOUT=1.</p></li> <li><p>Error message: <code class="docutils literal notranslate"><span class="pre">ValueError:</span> <span class="pre">invalid</span> <span class="pre">literal</span> <span class="pre">for</span> <span class="pre">int()</span> <span class="pre">with</span> <span class="pre">base</span> <span class="pre">10:</span> <span class="pre">''</span></code>. Simply re-run the script can solve this issue. This issue is already solved in the newer versions of transformers, see <a class="reference external" href="https://github.com/huggingface/transformers/pull/22427">https://github.com/huggingface/transformers/pull/22427</a>.</p></li> <li><p>Accelerator API workarounds:</p> <ul class="simple"> <li><p>Error message: “Gradient accumulation is not supported on TPU. Please set gradient_accumulation_steps to 1 and don’t pass in a GradientAccumulationPlugin object.” More context here: <a class="reference external" href="https://github.com/huggingface/accelerate/pull/479">https://github.com/huggingface/accelerate/pull/479</a>. The training still works by commenting out the assertion and avoid using the accumulation wrapper with accelerator.accumulate(model)</p></li> <li><p>Accelerator.prepare call: We have noticed that using the optimizer returned by this API are not directly reusable. It is due to gaps in configuring accelerate API for XLA devices.</p></li> </ul> </li> </ol> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="finetune_t5.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Fine-tune T5 model on Trn1</p> </div> </a> <a class="right-next" id="next-link" href="analyze_for_training.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Analyze for Training Tutorial</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:07.345Z
Neuron Custom C++ Operators Performance Optimization — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/neuron-customops/tutorials/customop-mlp-perf-opt.html
# Neuron Custom C++ Operators Performance Optimization — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Neuron Custom C++ Operators Performance Optimization[#](#neuron-custom-c-operators-performance-optimization "Permalink to this headline") In this tutorial, we will build on the small MLP model shown in [Neuron Custom C++ Operators in MLP Training](customop-mlp-training.html#neuronx-customop-mlp-tutorial) and demonstrate methods to optimize the performance of a custom C++ operator. We will be taking advantage of the TCM accessor as well as the usage of multiple GPSIMD cores to enhance performance. This tutorial assumes the reader has read and set up an environment described in [Neuron Custom C++ Operators in MLP Training](customop-mlp-training.html#neuronx-customop-mlp-tutorial). Table of Contents - [Download Examples](#download-examples) - [Model Configuration Adjustment](#model-configuration-adjustment) - [Performance with Element-wise Accessor](#performance-with-element-wise-accessor) - [Performance with TCM Accessor](#performance-with-tcm-accessor) - [Extending the example to utilize multiple GPSIMD cores](#extending-the-example-to-utilize-multiple-gpsimd-cores) ## [Download Examples](#id1)[#](#download-examples "Permalink to this headline") To download the source code for this tutorial, do: ``` git clone https://github.com/aws-neuron/aws-neuron-samples.git cd aws-neuron-samples/torch-neuronx/inference/customop_mlp ``` Note Custom C++ Operators are supported as of Neuron SDK Version 2.7 as a beta feature. As such this feature is not installed by default. Additional tooling and library packages (RPM and DEB) are required. On AL2, they can be installed with the following commands: ``` sudo yum remove python3-devel -y sudo yum remove aws-neuronx-gpsimd-tools-0.* -y sudo yum remove aws-neuronx-gpsimd-customop-lib-0.* -y sudo yum install python3-devel -y sudo yum install aws-neuronx-gpsimd-tools-0.* -y sudo yum install aws-neuronx-gpsimd-customop-lib-0.* -y ``` On Ubuntu, they can be installed with the following commands: ``` sudo apt-get remove python3-dev -y sudo apt-get remove aws-neuronx-gpsimd-tools=0.* -y sudo apt-get remove aws-neuronx-gpsimd-customop-lib=0.* -y sudo apt-get install python3-dev -y sudo apt-get install aws-neuronx-gpsimd-tools=0.* -y sudo apt-get install aws-neuronx-gpsimd-customop-lib=0.* -y ``` Activate the virtual environment created in [Neuron Custom C++ Operators in MLP Training](customop-mlp-training.html#neuronx-customop-mlp-tutorial), ``` source ~/aws_neuron_venv_pytorch/bin/activate ``` As a reminder, `ninja` should be already installed in the virtual environment. If not, install it for PyTorch Custom Extensions in your environment by running: ``` pip install regex pip install ninja ``` ## [Model Configuration Adjustment](#id2)[#](#model-configuration-adjustment "Permalink to this headline") For this tutorial, we will enlarge the size of the hidden layer from `[120, 84]` to `[4096, 2048]` in `model.py`. ``` import torch import torch.nn as nn from torch.nn import functional as F import my_ops # Declare 3-layer MLP for MNIST dataset class MLP(nn.Module): def __init__(self, input_size = 28 * 28, output_size = 10, layers = [4096, 2048]): super(MLP, self).__init__() self.fc1 = nn.Linear(input_size, layers[0]) self.fc2 = nn.Linear(layers[0], layers[1]) self.fc3 = nn.Linear(layers[1], output_size) def forward(self, x): f1 = self.fc1(x) r1 = my_ops.Relu.apply(f1) f2 = self.fc2(r1) r2 = my_ops.Relu.apply(f2) f3 = self.fc3(r2) return torch.log_softmax(f3, dim=1) ``` ## [Performance with Element-wise Accessor](#id3)[#](#performance-with-element-wise-accessor "Permalink to this headline") The `neuron` directory contains the same code shown in [Neuron Custom C++ Operators in MLP Training](customop-mlp-training.html#neuronx-customop-mlp-tutorial), where the `relu_forward` is implemented with element-wise accessor. Go to `neuron` directory, run `build.py` then `inference.py`, the expected output on a trn1 instance is, ``` Inf throughput (iter/sec): 8.098649744235592 ----------End Inference --------------- ``` ## [Performance with TCM Accessor](#id4)[#](#performance-with-tcm-accessor "Permalink to this headline") Now we switch to `neuron-tcm` folder. As mentioned in [Custom Operators API Reference Guide \[Experimental\]](../api-reference-guide/custom-ops-ref-guide.html#custom-ops-api-ref-guide), TCM accessors provide faster read and write performance. We implement the `relu_forward` using TCM accessor in `relu.cpp`: ``` torch::Tensor relu_forward(const torch::Tensor& t_in) { size_t num_elem = t_in.numel(); torch::Tensor t_out = torch::zeros(t_in.sizes(), torch::kFloat); static constexpr size_t buffer_size = 1024; float *tcm_buffer = (float*)torch::neuron::tcm_malloc(sizeof(float) * buffer_size); if (tcm_buffer != nullptr) { auto t_in_tcm_acc = t_in.tcm_accessor(); auto t_out_tcm_acc = t_out.tcm_accessor(); for (size_t i = 0; i < num_elem; i += buffer_size) { size_t remaining_elem = num_elem - i; size_t copy_size = (remaining_elem > buffer_size) ? buffer_size : remaining_elem; t_in_tcm_acc.tensor_to_tcm<float>(tcm_buffer, i, copy_size); for (size_t j = 0; j < copy_size; j++) { tcm_buffer[j] = tcm_buffer[j] > 0.0 ? tcm_buffer[j] : 0.0; } t_out_tcm_acc.tcm_to_tensor<float>(tcm_buffer, i, copy_size); } } torch::neuron::tcm_free(tcm_buffer); return t_out; } ``` Run `build.py` then `inference.py`, the expected output on a trn1 instance is: ``` Inf throughput (iter/sec): 220.73800131604054 ----------End Inference --------------- ``` ## [Extending the example to utilize multiple GPSIMD cores](#id5)[#](#extending-the-example-to-utilize-multiple-gpsimd-cores "Permalink to this headline") Now we switch to the `neuron-multicore` folder. We first enable the usage of multiple GPSIMD cores by `multicore=True` in the `build.py`. ``` custom_op.load( name='relu', compute_srcs=['relu.cpp'], shape_srcs=['shape.cpp'], build_directory=os.getcwd(), multicore=True, verbose=True ) ``` After passing the flag, the kernel function `relu_forward` defined in `relu.cpp` will execute on all GPSIMD cores. Thus we need to use `cpu_id` to partiton the workload among all cores. ``` torch::Tensor relu_forward(const torch::Tensor& t_in) { size_t num_elem = t_in.numel(); torch::Tensor t_out = get_dst_tensor(); uint32_t cpu_id = get_cpu_id(); uint32_t cpu_count = get_cpu_count(); uint32_t partition = num_elem / cpu_count; if (cpu_id == cpu_count - 1) { partition = num_elem - partition * (cpu_count - 1); } static constexpr size_t buffer_size = 1024; float *tcm_buffer = (float*)torch::neuron::tcm_malloc(sizeof(float) * buffer_size); if (tcm_buffer != nullptr) { auto t_in_tcm_acc = t_in.tcm_accessor(); auto t_out_tcm_acc = t_out.tcm_accessor(); for (size_t i = 0; i < partition; i += buffer_size) { size_t remaining_elem = partition - i; size_t copy_size = (remaining_elem > buffer_size) ? buffer_size : remaining_elem; t_in_tcm_acc.tensor_to_tcm<float>(tcm_buffer, partition *cpu_id + i, copy_size); for (size_t j = 0; j < copy_size; j++) { tcm_buffer[j] = tcm_buffer[j] > 0.0 ? tcm_buffer[j] : 0.0; } t_out_tcm_acc.tcm_to_tensor<float>(tcm_buffer, partition *cpu_id + i, copy_size); } } torch::neuron::tcm_free(tcm_buffer); return t_out; } ``` There are two things noteworthy in the code: 1. We use `cpu_id` and `cpu_count` to distribute the workload among all cores. Particularly, each cores performs `relu` on a partition of the tensor, the offset is computed based on `cpu_id`. 2. The output of the operator is directly written to the tensor from `get_dst_tensor()`. The `return t_out;` statement is ignored during execution. Run `build.py` then `inference.py`, the expected output on a trn1 instance is: ``` Inf throughput (iter/sec): 269.936119707143 ----------End Inference --------------- ``` Details of the API used in the sample here can be found in [Custom Operators API Reference Guide \[Experimental\]](../api-reference-guide/custom-ops-ref-guide.html#custom-ops-api-ref-guide). _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Neuron Custom C++ Operators Performance Optimization — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Additional Examples (torch-neuronx)" href="../../frameworks/torch/torch-neuronx/additional-examples-training.html"> <link rel="prev" title="Neuron Custom C++ Operators in MLP Training" href="customop-mlp-training.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "neuron-customops/tutorials/customop-mlp-perf-opt", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> Neuron C++ Custom Operators </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2 has-children"> <a class="reference internal" href="../api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="tutorials.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3"> <a class="reference internal" href="customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3 current active"> <a class="current reference internal" href="#"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fneuron-customops/tutorials/customop-mlp-perf-opt.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/neuron-customops/tutorials/customop-mlp-perf-opt.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/neuron-customops/tutorials/customop-mlp-perf-opt.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#download-examples"> Download Examples </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#model-configuration-adjustment"> Model Configuration Adjustment </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#performance-with-element-wise-accessor"> Performance with Element-wise Accessor </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#performance-with-tcm-accessor"> Performance with TCM Accessor </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#extending-the-example-to-utilize-multiple-gpsimd-cores"> Extending the example to utilize multiple GPSIMD cores </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Neuron Custom C++ Operators Performance Optimization</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#download-examples"> Download Examples </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#model-configuration-adjustment"> Model Configuration Adjustment </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#performance-with-element-wise-accessor"> Performance with Element-wise Accessor </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#performance-with-tcm-accessor"> Performance with TCM Accessor </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#extending-the-example-to-utilize-multiple-gpsimd-cores"> Extending the example to utilize multiple GPSIMD cores </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="neuron-custom-c-operators-performance-optimization"> <span id="neuronx-customop-mlp-perf"></span><h1>Neuron Custom C++ Operators Performance Optimization<a class="headerlink" href="#neuron-custom-c-operators-performance-optimization" title="Permalink to this headline">#</a></h1> <p>In this tutorial, we will build on the small MLP model shown in <a class="reference internal" href="customop-mlp-training.html#neuronx-customop-mlp-tutorial"><span class="std std-ref">Neuron Custom C++ Operators in MLP Training</span></a> and demonstrate methods to optimize the performance of a custom C++ operator. We will be taking advantage of the TCM accessor as well as the usage of multiple GPSIMD cores to enhance performance.</p> <p>This tutorial assumes the reader has read and set up an environment described in <a class="reference internal" href="customop-mlp-training.html#neuronx-customop-mlp-tutorial"><span class="std std-ref">Neuron Custom C++ Operators in MLP Training</span></a>.</p> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#download-examples" id="id1">Download Examples</a></p></li> <li><p><a class="reference internal" href="#model-configuration-adjustment" id="id2">Model Configuration Adjustment</a></p></li> <li><p><a class="reference internal" href="#performance-with-element-wise-accessor" id="id3">Performance with Element-wise Accessor</a></p></li> <li><p><a class="reference internal" href="#performance-with-tcm-accessor" id="id4">Performance with TCM Accessor</a></p></li> <li><p><a class="reference internal" href="#extending-the-example-to-utilize-multiple-gpsimd-cores" id="id5">Extending the example to utilize multiple GPSIMD cores</a></p></li> </ul> </div> <div class="section" id="download-examples"> <h2><a class="toc-backref" href="#id1">Download Examples</a><a class="headerlink" href="#download-examples" title="Permalink to this headline">#</a></h2> <p>To download the source code for this tutorial, do:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/aws-neuron/aws-neuron-samples.git <span class="nb">cd</span><span class="w"> </span>aws-neuron-samples/torch-neuronx/inference/customop_mlp </pre></div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>We will be using an inference example in this tutorial in order to adhere to certain Custom C++ operator restrictions when using multiple GPSIMD cores (see <a class="reference internal" href="../api-reference-guide/custom-ops-ref-guide.html#custom-ops-api-ref-guide"><span class="std std-ref">Custom Operators API Reference Guide [Experimental]</span></a> for details on current restrictions).</p> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Custom C++ Operators are supported as of Neuron SDK Version 2.7 as a beta feature. As such this feature is not installed by default. Additional tooling and library packages (RPM and DEB) are required. On AL2, they can be installed with the following commands:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="n">remove</span> <span class="n">python3</span><span class="o">-</span><span class="n">devel</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">remove</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">tools</span><span class="o">-</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">remove</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">customop</span><span class="o">-</span><span class="n">lib</span><span class="o">-</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">python3</span><span class="o">-</span><span class="n">devel</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">tools</span><span class="o">-</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">customop</span><span class="o">-</span><span class="n">lib</span><span class="o">-</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> </pre></div> </div> <p>On Ubuntu, they can be installed with the following commands:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">remove</span> <span class="n">python3</span><span class="o">-</span><span class="n">dev</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">remove</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">tools</span><span class="o">=</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">remove</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">customop</span><span class="o">-</span><span class="n">lib</span><span class="o">=</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">python3</span><span class="o">-</span><span class="n">dev</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">tools</span><span class="o">=</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> <span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">aws</span><span class="o">-</span><span class="n">neuronx</span><span class="o">-</span><span class="n">gpsimd</span><span class="o">-</span><span class="n">customop</span><span class="o">-</span><span class="n">lib</span><span class="o">=</span><span class="mf">0.</span><span class="o">*</span> <span class="o">-</span><span class="n">y</span> </pre></div> </div> </div> <p>Activate the virtual environment created in <a class="reference internal" href="customop-mlp-training.html#neuronx-customop-mlp-tutorial"><span class="std std-ref">Neuron Custom C++ Operators in MLP Training</span></a>,</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>~/aws_neuron_venv_pytorch/bin/activate </pre></div> </div> <p>As a reminder, <code class="docutils literal notranslate"><span class="pre">ninja</span></code> should be already installed in the virtual environment. If not, install it for PyTorch Custom Extensions in your environment by running:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>regex pip<span class="w"> </span>install<span class="w"> </span>ninja </pre></div> </div> </div> <div class="section" id="model-configuration-adjustment"> <h2><a class="toc-backref" href="#id2">Model Configuration Adjustment</a><a class="headerlink" href="#model-configuration-adjustment" title="Permalink to this headline">#</a></h2> <p>For this tutorial, we will enlarge the size of the hidden layer from <code class="docutils literal notranslate"><span class="pre">[120,</span> <span class="pre">84]</span></code> to <code class="docutils literal notranslate"><span class="pre">[4096,</span> <span class="pre">2048]</span></code> in <code class="docutils literal notranslate"><span class="pre">model.py</span></code>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="kn">from</span> <span class="nn">torch.nn</span> <span class="kn">import</span> <span class="n">functional</span> <span class="k">as</span> <span class="n">F</span> <span class="kn">import</span> <span class="nn">my_ops</span> <span class="c1"># Declare 3-layer MLP for MNIST dataset</span> <span class="k">class</span> <span class="nc">MLP</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="hll"> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">input_size</span> <span class="o">=</span> <span class="mi">28</span> <span class="o">*</span> <span class="mi">28</span><span class="p">,</span> <span class="n">output_size</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span> <span class="n">layers</span> <span class="o">=</span> <span class="p">[</span><span class="mi">4096</span><span class="p">,</span> <span class="mi">2048</span><span class="p">]):</span> </span> <span class="nb">super</span><span class="p">(</span><span class="n">MLP</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc1</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">input_size</span><span class="p">,</span> <span class="n">layers</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc2</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">layers</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">layers</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc3</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">layers</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">output_size</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="n">f1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc1</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="n">r1</span> <span class="o">=</span> <span class="n">my_ops</span><span class="o">.</span><span class="n">Relu</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">f1</span><span class="p">)</span> <span class="n">f2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc2</span><span class="p">(</span><span class="n">r1</span><span class="p">)</span> <span class="n">r2</span> <span class="o">=</span> <span class="n">my_ops</span><span class="o">.</span><span class="n">Relu</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">f2</span><span class="p">)</span> <span class="n">f3</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc3</span><span class="p">(</span><span class="n">r2</span><span class="p">)</span> <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">log_softmax</span><span class="p">(</span><span class="n">f3</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="performance-with-element-wise-accessor"> <h2><a class="toc-backref" href="#id3">Performance with Element-wise Accessor</a><a class="headerlink" href="#performance-with-element-wise-accessor" title="Permalink to this headline">#</a></h2> <p>The <code class="docutils literal notranslate"><span class="pre">neuron</span></code> directory contains the same code shown in <a class="reference internal" href="customop-mlp-training.html#neuronx-customop-mlp-tutorial"><span class="std std-ref">Neuron Custom C++ Operators in MLP Training</span></a>, where the <code class="docutils literal notranslate"><span class="pre">relu_forward</span></code> is implemented with element-wise accessor. Go to <code class="docutils literal notranslate"><span class="pre">neuron</span></code> directory, run <code class="docutils literal notranslate"><span class="pre">build.py</span></code> then <code class="docutils literal notranslate"><span class="pre">inference.py</span></code>, the expected output on a trn1 instance is,</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Inf<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">8</span>.098649744235592 ----------End<span class="w"> </span>Inference<span class="w"> </span>--------------- </pre></div> </div> </div> <div class="section" id="performance-with-tcm-accessor"> <h2><a class="toc-backref" href="#id4">Performance with TCM Accessor</a><a class="headerlink" href="#performance-with-tcm-accessor" title="Permalink to this headline">#</a></h2> <p>Now we switch to <code class="docutils literal notranslate"><span class="pre">neuron-tcm</span></code> folder. As mentioned in <a class="reference internal" href="../api-reference-guide/custom-ops-ref-guide.html#custom-ops-api-ref-guide"><span class="std std-ref">Custom Operators API Reference Guide [Experimental]</span></a>, TCM accessors provide faster read and write performance. We implement the <code class="docutils literal notranslate"><span class="pre">relu_forward</span></code> using TCM accessor in <code class="docutils literal notranslate"><span class="pre">relu.cpp</span></code>:</p> <div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="nf">relu_forward</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="o">&amp;</span><span class="w"> </span><span class="n">t_in</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">num_elem</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">t_in</span><span class="p">.</span><span class="n">numel</span><span class="p">();</span> <span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="n">t_out</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">zeros</span><span class="p">(</span><span class="n">t_in</span><span class="p">.</span><span class="n">sizes</span><span class="p">(),</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">kFloat</span><span class="p">);</span> <span class="w"> </span><span class="k">static</span><span class="w"> </span><span class="k">constexpr</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">buffer_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1024</span><span class="p">;</span> <span class="w"> </span><span class="kt">float</span><span class="w"> </span><span class="o">*</span><span class="n">tcm_buffer</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="kt">float</span><span class="o">*</span><span class="p">)</span><span class="n">torch</span><span class="o">::</span><span class="n">neuron</span><span class="o">::</span><span class="n">tcm_malloc</span><span class="p">(</span><span class="k">sizeof</span><span class="p">(</span><span class="kt">float</span><span class="p">)</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">buffer_size</span><span class="p">);</span> <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">tcm_buffer</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="k">nullptr</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="k">auto</span><span class="w"> </span><span class="n">t_in_tcm_acc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">t_in</span><span class="p">.</span><span class="n">tcm_accessor</span><span class="p">();</span> <span class="w"> </span><span class="k">auto</span><span class="w"> </span><span class="n">t_out_tcm_acc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">t_out</span><span class="p">.</span><span class="n">tcm_accessor</span><span class="p">();</span> <span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="kt">size_t</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="n">num_elem</span><span class="p">;</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="n">buffer_size</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">remaining_elem</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">num_elem</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">i</span><span class="p">;</span> <span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">copy_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">remaining_elem</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="n">buffer_size</span><span class="p">)</span><span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="n">buffer_size</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="n">remaining_elem</span><span class="p">;</span> <span class="w"> </span><span class="n">t_in_tcm_acc</span><span class="p">.</span><span class="n">tensor_to_tcm</span><span class="o">&lt;</span><span class="kt">float</span><span class="o">&gt;</span><span class="p">(</span><span class="n">tcm_buffer</span><span class="p">,</span><span class="w"> </span><span class="n">i</span><span class="p">,</span><span class="w"> </span><span class="n">copy_size</span><span class="p">);</span> <span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="kt">size_t</span><span class="w"> </span><span class="n">j</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"> </span><span class="n">j</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="n">copy_size</span><span class="p">;</span><span class="w"> </span><span class="n">j</span><span class="o">++</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="n">tcm_buffer</span><span class="p">[</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tcm_buffer</span><span class="p">[</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="mf">0.0</span><span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="n">tcm_buffer</span><span class="p">[</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="mf">0.0</span><span class="p">;</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="n">t_out_tcm_acc</span><span class="p">.</span><span class="n">tcm_to_tensor</span><span class="o">&lt;</span><span class="kt">float</span><span class="o">&gt;</span><span class="p">(</span><span class="n">tcm_buffer</span><span class="p">,</span><span class="w"> </span><span class="n">i</span><span class="p">,</span><span class="w"> </span><span class="n">copy_size</span><span class="p">);</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">neuron</span><span class="o">::</span><span class="n">tcm_free</span><span class="p">(</span><span class="n">tcm_buffer</span><span class="p">);</span> <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">t_out</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>Run <code class="docutils literal notranslate"><span class="pre">build.py</span></code> then <code class="docutils literal notranslate"><span class="pre">inference.py</span></code>, the expected output on a trn1 instance is:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Inf<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">220</span>.73800131604054 ----------End<span class="w"> </span>Inference<span class="w"> </span>--------------- </pre></div> </div> </div> <div class="section" id="extending-the-example-to-utilize-multiple-gpsimd-cores"> <h2><a class="toc-backref" href="#id5">Extending the example to utilize multiple GPSIMD cores</a><a class="headerlink" href="#extending-the-example-to-utilize-multiple-gpsimd-cores" title="Permalink to this headline">#</a></h2> <p>Now we switch to the <code class="docutils literal notranslate"><span class="pre">neuron-multicore</span></code> folder. We first enable the usage of multiple GPSIMD cores by <code class="docutils literal notranslate"><span class="pre">multicore=True</span></code> in the <code class="docutils literal notranslate"><span class="pre">build.py</span></code>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">custom_op</span><span class="o">.</span><span class="n">load</span><span class="p">(</span> <span class="n">name</span><span class="o">=</span><span class="s1">'relu'</span><span class="p">,</span> <span class="n">compute_srcs</span><span class="o">=</span><span class="p">[</span><span class="s1">'relu.cpp'</span><span class="p">],</span> <span class="n">shape_srcs</span><span class="o">=</span><span class="p">[</span><span class="s1">'shape.cpp'</span><span class="p">],</span> <span class="n">build_directory</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span> <span class="n">multicore</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span> <span class="p">)</span> </pre></div> </div> <p>After passing the flag, the kernel function <code class="docutils literal notranslate"><span class="pre">relu_forward</span></code> defined in <code class="docutils literal notranslate"><span class="pre">relu.cpp</span></code> will execute on all GPSIMD cores. Thus we need to use <code class="docutils literal notranslate"><span class="pre">cpu_id</span></code> to partiton the workload among all cores.</p> <div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="nf">relu_forward</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="o">&amp;</span><span class="w"> </span><span class="n">t_in</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">num_elem</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">t_in</span><span class="p">.</span><span class="n">numel</span><span class="p">();</span> <span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">Tensor</span><span class="w"> </span><span class="n">t_out</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">get_dst_tensor</span><span class="p">();</span> <span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">cpu_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">get_cpu_id</span><span class="p">();</span> <span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">cpu_count</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">get_cpu_count</span><span class="p">();</span> <span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">partition</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">num_elem</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="n">cpu_count</span><span class="p">;</span> <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">cpu_id</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">cpu_count</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="n">partition</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">num_elem</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">partition</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="p">(</span><span class="n">cpu_count</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="mi">1</span><span class="p">);</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="k">static</span><span class="w"> </span><span class="k">constexpr</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">buffer_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1024</span><span class="p">;</span> <span class="w"> </span><span class="kt">float</span><span class="w"> </span><span class="o">*</span><span class="n">tcm_buffer</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="kt">float</span><span class="o">*</span><span class="p">)</span><span class="n">torch</span><span class="o">::</span><span class="n">neuron</span><span class="o">::</span><span class="n">tcm_malloc</span><span class="p">(</span><span class="k">sizeof</span><span class="p">(</span><span class="kt">float</span><span class="p">)</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">buffer_size</span><span class="p">);</span> <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">tcm_buffer</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="k">nullptr</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="k">auto</span><span class="w"> </span><span class="n">t_in_tcm_acc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">t_in</span><span class="p">.</span><span class="n">tcm_accessor</span><span class="p">();</span> <span class="w"> </span><span class="k">auto</span><span class="w"> </span><span class="n">t_out_tcm_acc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">t_out</span><span class="p">.</span><span class="n">tcm_accessor</span><span class="p">();</span> <span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="kt">size_t</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="n">partition</span><span class="p">;</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="n">buffer_size</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">remaining_elem</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">partition</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">i</span><span class="p">;</span> <span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">copy_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">remaining_elem</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="n">buffer_size</span><span class="p">)</span><span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="n">buffer_size</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="n">remaining_elem</span><span class="p">;</span> <span class="w"> </span><span class="n">t_in_tcm_acc</span><span class="p">.</span><span class="n">tensor_to_tcm</span><span class="o">&lt;</span><span class="kt">float</span><span class="o">&gt;</span><span class="p">(</span><span class="n">tcm_buffer</span><span class="p">,</span><span class="w"> </span><span class="n">partition</span><span class="w"> </span><span class="o">*</span><span class="n">cpu_id</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">i</span><span class="p">,</span><span class="w"> </span><span class="n">copy_size</span><span class="p">);</span> <span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="kt">size_t</span><span class="w"> </span><span class="n">j</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"> </span><span class="n">j</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="n">copy_size</span><span class="p">;</span><span class="w"> </span><span class="n">j</span><span class="o">++</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="n">tcm_buffer</span><span class="p">[</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tcm_buffer</span><span class="p">[</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="mf">0.0</span><span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="n">tcm_buffer</span><span class="p">[</span><span class="n">j</span><span class="p">]</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="mf">0.0</span><span class="p">;</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="n">t_out_tcm_acc</span><span class="p">.</span><span class="n">tcm_to_tensor</span><span class="o">&lt;</span><span class="kt">float</span><span class="o">&gt;</span><span class="p">(</span><span class="n">tcm_buffer</span><span class="p">,</span><span class="w"> </span><span class="n">partition</span><span class="w"> </span><span class="o">*</span><span class="n">cpu_id</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">i</span><span class="p">,</span><span class="w"> </span><span class="n">copy_size</span><span class="p">);</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="n">torch</span><span class="o">::</span><span class="n">neuron</span><span class="o">::</span><span class="n">tcm_free</span><span class="p">(</span><span class="n">tcm_buffer</span><span class="p">);</span> <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">t_out</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>There are two things noteworthy in the code:</p> <ol class="arabic simple"> <li><p>We use <code class="docutils literal notranslate"><span class="pre">cpu_id</span></code> and <code class="docutils literal notranslate"><span class="pre">cpu_count</span></code> to distribute the workload among all cores. Particularly, each cores performs <code class="docutils literal notranslate"><span class="pre">relu</span></code> on a partition of the tensor, the offset is computed based on <code class="docutils literal notranslate"><span class="pre">cpu_id</span></code>.</p></li> <li><p>The output of the operator is directly written to the tensor from <code class="docutils literal notranslate"><span class="pre">get_dst_tensor()</span></code>. The <code class="docutils literal notranslate"><span class="pre">return</span> <span class="pre">t_out;</span></code> statement is ignored during execution.</p></li> </ol> <p>Run <code class="docutils literal notranslate"><span class="pre">build.py</span></code> then <code class="docutils literal notranslate"><span class="pre">inference.py</span></code>, the expected output on a trn1 instance is:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Inf<span class="w"> </span>throughput<span class="w"> </span><span class="o">(</span>iter/sec<span class="o">)</span>:<span class="w"> </span><span class="m">269</span>.936119707143 ----------End<span class="w"> </span>Inference<span class="w"> </span>--------------- </pre></div> </div> <p>Details of the API used in the sample here can be found in <a class="reference internal" href="../api-reference-guide/custom-ops-ref-guide.html#custom-ops-api-ref-guide"><span class="std std-ref">Custom Operators API Reference Guide [Experimental]</span></a>.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="customop-mlp-training.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Neuron Custom C++ Operators in MLP Training</p> </div> </a> <a class="right-next" id="next-link" href="../../frameworks/torch/torch-neuronx/additional-examples-training.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:07.688Z
Additional Examples (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/additional-examples-training.html
# Additional Examples (torch-neuronx) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/additional-examples-training.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/additional-examples-training.rst) - [.rst](../../../_sources/frameworks/torch/torch-neuronx/additional-examples-training.rst.txt) ## Additional Examples (torch-neuronx) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Additional Examples (`torch-neuronx`)[#](#additional-examples-torch-neuronx "Permalink to this headline") - [AWS Neuron Reference for Nemo Megatron GitHub Repository](https://github.com/aws-neuron/neuronx-nemo-megatron) - [AWS Neuron Samples for EKS](https://github.com/aws-neuron/aws-neuron-eks-samples) - [AWS Neuron Samples for AWS ParallelCluster](https://github.com/aws-neuron/aws-neuron-parallelcluster-samples) - [AWS Neuron Samples GitHub Repository](https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Additional Examples (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="API Reference Guide for Training (torch-neuronx)" href="api-reference-guide/training/index.html"> <link rel="prev" title="Neuron Custom C++ Operators Performance Optimization" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/additional-examples-training", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Additional Examples </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/additional-examples-training.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/additional-examples-training.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuronx/additional-examples-training.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Additional Examples (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="additional-examples-torch-neuronx"> <h1>Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#additional-examples-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron">AWS Neuron Reference for Nemo Megatron GitHub Repository</a></p></li> <li><p><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples">AWS Neuron Samples for EKS</a></p></li> <li><p><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples">AWS Neuron Samples for AWS ParallelCluster</a></p></li> <li><p><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training">AWS Neuron Samples GitHub Repository</a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Neuron Custom C++ Operators Performance Optimization</p> </div> </a> <a class="right-next" id="next-link" href="api-reference-guide/training/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">API Reference Guide for Training (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:07.918Z
API Reference Guide for Training (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/training/index.html
# API Reference Guide for Training (torch-neuronx) — AWS Neuron Documentation previous Additional Examples (`torch-neuronx`)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>API Reference Guide for Training (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="PyTorch Neuron neuron_parallel_compile CLI (torch-neuronx)" href="pytorch-neuron-parallel-compile.html"> <link rel="prev" title="Additional Examples (torch-neuronx)" href="../../additional-examples-training.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/api-reference-guide/training/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/api-reference-guide/training/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/training/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/api-reference-guide/training/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>API Reference Guide for Training (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="api-reference-guide-for-training-torch-neuronx"> <h1>API Reference Guide for Training (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#api-reference-guide-for-training-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> API Reference Guide for Training (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">PyTorch Neuron neuron_parallel_compile CLI (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="torch-neuron-envvars.html#pytorch-neuronx-envvars"><span class="std std-ref">PyTorch Neuron Environment Variables (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../torch-neuronx-profiling-api.html#torch-neuronx-profiling-api"><span class="std std-ref">PyTorch Neuron (torch-neuronx) Profiling API</span></a></p></li> </ul> </div> </details><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../additional-examples-training.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Additional Examples (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="pytorch-neuron-parallel-compile.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron neuron_parallel_compile CLI (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:08.202Z
PyTorch Neuron neuron_parallel_compile CLI (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html
# PyTorch Neuron neuron\_parallel\_compile CLI (torch-neuronx) — AWS Neuron Documentation ## PyTorch Neuron neuron\_parallel\_compile CLI (`torch-neuronx`)[#](#pytorch-neuron-neuron-parallel-compile-cli-torch-neuronx "Permalink to this headline") PyTorch Neuron performs just-in-time compilation of graphs during execution. At every step, a graph is traced. If the traced graph varies from the previous executions, it is compiled by the neuron compiler. For large models, the compilation time for each graph can be high. Moreover, because of JIT, we would compile all these graphs sequentially, hence incurring huge compilation penalty. To reduce this compilation time during execution, the `neuron_parallel_compile` utility is provided as part of PyTorch Neuron installation. The `neuron_parallel_compile` will extract graphs from a trial run of your script, perform parallel pre-compilation of the graphs, and populate the [Neuron Persistent Cache](../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching) on disk or in AWS S3 bucket with compiled graphs. Your trial run should be limited to a few steps (eg.10-15), enough for the utility to extract the different graphs needed for full execution. To run the utility: `neuron_parallel_compile <run commands>` Where `<run commands>` are the commands to run a short run (i.e. 10 steps) to trace training loops for pre-compilation. The example for the run command is `torchrun --nproc_per_node=2 <train script>`, where train script accepts `--steps_this_run` option to limit number of run steps: `neuron_parallel_compile torchrun --nproc_per_node=2 <train script> --steps_this_run=10` You may notice that the output from the model is invalid when you use `neuron_parallel_compile`. This is because when you initiate your training run command with `neuron_parallel_compile`, the utility will run your command with environment variables that puts your training script into graph extraction mode. In this mode, no real execution is performed and the outputs are invalid. You will also see outputs similar to the following about the compile cache path and the extracted graphs: ``` INFO ||NEURON_CACHE||: Compile cache path: /var/tmp/neuron-compile-cache INFO ||NEURON_CC_WRAPPER||: Extracting graphs (/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_9219523464496887986+abb26765/model.hlo.pb) for ahead-of-time parallel compilation. No compilation was done. ``` After the trial execution ends and the graphs are extracted, `neuron_parallel_compile` would launch multiple compilation processes in parallel to compile all these graphs. Compiled graphs (NEFFs) are inserted into the Neuron Persistent Cache. You will also see outputs similar to the following about the compile cache path, the list of graphs (HLOs) to be compiled, and the running statistics of compiled graphs (count of remaining graphs, locked graphs, failed graphs, done compiled graphs). ``` INFO ||NEURON_CACHE||: Compile cache path: /var/tmp/neuron-compile-cache INFO ||NEURON_CACHE||: Current remaining items are 5, locked are 0, failed are 0, done are 0, total is 5 INFO ||NEURON_PARALLEL_COMPILE||: master grab hlos to compile: ['/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_8068656800389078395+abb26765/model.hlo.pb', '/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_17109392703413819652+abb26765/model.hlo.pb', '/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_9219523464496887986+abb26765/model.hlo.pb', '/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_16969875447143373016+abb26765/model.hlo.pb', '/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_3000743782456078279+abb26765/model.hlo.pb'] ... INFO ||NEURON_CACHE||: Current remaining items are 0, locked are 0, failed are 0, done are 5, total is 5 ``` After all compilations are completed, a compilation summary is shown: ``` INFO: 2023-08-24 20:21:11.000895: 161136 INFO ||NEURON_PARALLEL_COMPILE||: { INFO: "compilation_summary": { INFO: "true": 2 INFO: }, INFO: "compilation_report": { INFO: "/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_1970132581169579119+abb26765/model.hlo.pb": { INFO: "status": true, INFO: "retry": 0 INFO: }, INFO: "/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_16141953836240613513+abb26765/model.hlo.pb": { INFO: "status": true, INFO: "retry": 0 INFO: } INFO: } INFO: } INFO: 2023-08-24 20:21:11.000895: 161136 INFO ||NEURON_PARALLEL_COMPILE||: Total graphs: 2 INFO: 2023-08-24 20:21:11.000895: 161136 INFO ||NEURON_PARALLEL_COMPILE||: Total successful compilations: 2 INFO: 2023-08-24 20:21:11.000895: 161136 INFO ||NEURON_PARALLEL_COMPILE||: Total failed compilations: 0 ``` Now if you run your script (without `neuron_parallel_compile`), it will be faster since the compiled graphs are already cached. `torchrun --nproc_per_node=2 <train script>` `Note`: Except for the option to limit number of run steps (such as `--steps_this_run`), the other options of `<run commands>` must match between the pre-compilation and actual run. If this is not the case, you may see additional compilations during training run because of new graphs getting generated, resulting in cache miss. There may be additional compilations due to unreached execution paths (in case the execution path is not reached in the first few steps of graph extraction), or changes in parameters such as number of data parallel workers. Each precompilation command or actual script execution command above can be prefixed with `NEURON_COMPILE_CACHE_URL=<cache URL>` or `NEURON_CC_FLAGS="--cache_dir=<cache URL>"` to specify a different cache location than the default (with `--cache_dir` taking precedence over `NEURON_COMPILE_CACHE_URL` if both are specified). Alternatively, the cache URL can also be specify in Python code using: ``` os.environ['NEURON_CC_FLAGS'] = os.environ.get('NEURON_CC_FLAGS', '') + "--cache_dir=<cache URL>" ``` You need to specify the same cache URL for both the precompilation command (using `neuron_parallel_compile`) and the actual script execution command if you want the previously compiled and cached graphs to be used for actual script execution. The environment variables below are available to help modify `neuron_parallel_compile` behavior: `NEURON_PARALLEL_COMPILE_MAX_RETRIES` : - Set the maximum number of retries when using [Neuron Persistent Cache](../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching) or [neuron\_parallel\_compile](#pytorch-neuronx-parallel-compile-cli). If set to N, the tool will try compilation N more time(s) if the first graph compilation failed. Example: Set NEURON\_PARALLEL\_COMPILE\_MAX\_RETRIES=1 when precompiling on trn1.2xlarge where there’s limited host memory and CPU resources. Default is 0. `NEURON_IGNORE_TRAINING_SCRIPT_ERROR_AND_COMPILE` : - When using [Neuron Persistent Cache](../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching) or [neuron\_parallel\_compile](#pytorch-neuronx-parallel-compile-cli) , if you want to ignore the error in training script and compile the accumulated HLO graphs, you can do so by setting this environment variable. Example: If NEURON\_IGNORE\_TRAINING\_SCRIPT\_ERROR\_AND\_COMPILE=1 is set when using `neuron_parallel_compile`, a crash in the training script would be ignored and the graphs collected upto the crash would be compiled. `NEURON_COMPILE_CACHE_URL`: - Set the [Neuron Persistent Cache](../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching) URL or [neuron\_parallel\_compile](#pytorch-neuronx-parallel-compile-cli). If starts with `s3://`, it will use AWS S3 as cache backend. Otherwise it will use local disk cache. Default is `/var/tmp/neuron-compile-cache`. If this is specified together with `cache_dir=<cache_url>` option via `NEURON_CC_FLAGS`, the `--cache_dir` option takes precedence. ## Debugging with Neuron Persistent Cache[#](#debugging-with-neuron-persistent-cache "Permalink to this headline") A graph compilation can fail because of a compilation error or an environment issue (for example, compilation is interrupted by ctrl-C). The graph would be marked as failed and subsequent rerun would encounter message like below: ``` INFO ||NCC_WRAPPER||: Got a cached failed neff at /var/tmp/neuron-compile-cache/neuronxcc-2.8.0.25+a3ad0f342/MODULE_12486829708343293975+d41d8cd9/model.neff. Will skip compilation, please set --retry_failed_compilation for recompilation. ``` To retry compilation, add `--retry_failed_compilation` in `NEURON_CC_FLAGS` environment variable. This will retry the compilation even if the graph was previously marked as failed compilation. ``` os.environ['NEURON_CC_FLAGS'] = os.environ.get('NEURON_CC_FLAGS', '') + ' --retry_failed_compilation' ``` See [Neuron Persistent Cache](../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching) for more information. ## Separate collection and compilation commands[#](#separate-collection-and-compilation-commands "Permalink to this headline") For cases like finetuning, there could be multiple independent training tasks running on different nodes and sharing many compilation graphs in common. `neuron_parallel_compile` provides commands to separate the graph collection and compilation phases, so users can collect all graphs across different training sessions in advance to avoid duplicate compilations. To only collect the graphs from trial executions of training scripts into Neuron Persistent Cache: ``` neuron_parallel_compile --command collect <run_script> ``` To compile the graph previously collected using `collect` command and store compiled result (NEFFs) back into Neuron Persistent Cache (make sure to use the same neuronx-cc compiler version as during the graph collection step): ``` ``neuron_parallel_compile --command compile <run_script>`` ``` Note: if `--command` is not specified, `neuron_parallel_compile` will do both collection and compilation phases by default. ## Cache maintenance commands[#](#cache-maintenance-commands "Permalink to this headline") The following commands are available to help maintain the cache. Warning Make sure no running process is using the cache when you use `clean` or `clear-locks` command because it can cause cache errors. To clean cached files: ``` # WARNING: Make sure no running process is using the cache neuron_parallel_compile --command clean ``` To clear file locks left behind when a `neuron_parallel_compile` execution was interrupted: ``` # WARNING: Make sure no running process is using the cache neuron_parallel_compile --command clear-locks ``` Each command above can be prefixed with `NEURON_COMPILE_CACHE_URL=<cache URL>` or `NEURON_CC_FLAGS="--cache_dir=<cache URL>"` to specify a different cache location than the default. Note Currently there’s no automatic maintenance of cache size either on disk or in S3. Please delete files (i.e. older compiler versions) as necessary to keep cache size within your limit. ## Analyze operations support[#](#analyze-operations-support "Permalink to this headline") The analyze command checks the support of operations within the training script by checking each operator against neuronx-cc. It is only supported for PyTorch models. The output of the tool will be available as result.json within the output location. ``` neuron_parallel_compile --command analyze python3 training_script.py ``` Optional Arguments: > `--analyze-output ANALYZE_OUTPUT_LOCATION` Only supported for –command analyze. Path to location where output will be persisted. Default: cwd/model\_analysis\_result > > `--analyze-verbosity {1,2}` Only supported for –command analyze. Level of information to be included within the output. 1: add XLA operator information into the results. 2: add aten metadata into results. Default: 2 The tutorial for `analyze` can be found [here](../../tutorials/training/analyze_for_training.html#torch-analyze-for-training-tutorial) _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron neuron_parallel_compile CLI (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="PyTorch Neuron Environment Variables (torch-neuronx)" href="torch-neuron-envvars.html"> <link rel="prev" title="API Reference Guide for Training (torch-neuronx)" href="index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="index.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#debugging-with-neuron-persistent-cache"> Debugging with Neuron Persistent Cache </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#separate-collection-and-compilation-commands"> Separate collection and compilation commands </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#cache-maintenance-commands"> Cache maintenance commands </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#analyze-operations-support"> Analyze operations support </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron neuron_parallel_compile CLI (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#debugging-with-neuron-persistent-cache"> Debugging with Neuron Persistent Cache </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#separate-collection-and-compilation-commands"> Separate collection and compilation commands </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#cache-maintenance-commands"> Cache maintenance commands </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#analyze-operations-support"> Analyze operations support </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-neuron-parallel-compile-cli-torch-neuronx"> <span id="pytorch-neuronx-parallel-compile-cli"></span><h1>PyTorch Neuron neuron_parallel_compile CLI (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#pytorch-neuron-neuron-parallel-compile-cli-torch-neuronx" title="Permalink to this headline">#</a></h1> <p>PyTorch Neuron performs just-in-time compilation of graphs during execution. At every step, a graph is traced. If the traced graph varies from the previous executions, it is compiled by the neuron compiler. For large models, the compilation time for each graph can be high. Moreover, because of JIT, we would compile all these graphs sequentially, hence incurring huge compilation penalty.</p> <p>To reduce this compilation time during execution, the <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> utility is provided as part of PyTorch Neuron installation. The <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> will extract graphs from a trial run of your script, perform parallel pre-compilation of the graphs, and populate the <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a> on disk or in AWS S3 bucket with compiled graphs. Your trial run should be limited to a few steps (eg.10-15), enough for the utility to extract the different graphs needed for full execution. To run the utility:</p> <p><code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span> <span class="pre">&lt;run</span> <span class="pre">commands&gt;</span></code></p> <p>Where <code class="docutils literal notranslate"><span class="pre">&lt;run</span> <span class="pre">commands&gt;</span></code> are the commands to run a short run (i.e. 10 steps) to trace training loops for pre-compilation. The example for the run command is <code class="docutils literal notranslate"><span class="pre">torchrun</span> <span class="pre">--nproc_per_node=2</span> <span class="pre">&lt;train</span> <span class="pre">script&gt;</span></code>, where train script accepts <code class="docutils literal notranslate"><span class="pre">--steps_this_run</span></code> option to limit number of run steps:</p> <p><code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span> <span class="pre">torchrun</span> <span class="pre">--nproc_per_node=2</span> <span class="pre">&lt;train</span> <span class="pre">script&gt;</span> <span class="pre">--steps_this_run=10</span></code></p> <p>You may notice that the output from the model is invalid when you use <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code>. This is because when you initiate your training run command with <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code>, the utility will run your command with environment variables that puts your training script into graph extraction mode. In this mode, no real execution is performed and the outputs are invalid. You will also see outputs similar to the following about the compile cache path and the extracted graphs:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>INFO<span class="w"> </span><span class="o">||</span>NEURON_CACHE<span class="o">||</span>:<span class="w"> </span>Compile<span class="w"> </span>cache<span class="w"> </span>path:<span class="w"> </span>/var/tmp/neuron-compile-cache INFO<span class="w"> </span><span class="o">||</span>NEURON_CC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Extracting<span class="w"> </span>graphs<span class="w"> </span><span class="o">(</span>/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_9219523464496887986+abb26765/model.hlo.pb<span class="o">)</span><span class="w"> </span><span class="k">for</span><span class="w"> </span>ahead-of-time<span class="w"> </span>parallel<span class="w"> </span>compilation.<span class="w"> </span>No<span class="w"> </span>compilation<span class="w"> </span>was<span class="w"> </span><span class="k">done</span>. </pre></div> </div> <p>After the trial execution ends and the graphs are extracted, <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> would launch multiple compilation processes in parallel to compile all these graphs. Compiled graphs (NEFFs) are inserted into the Neuron Persistent Cache. You will also see outputs similar to the following about the compile cache path, the list of graphs (HLOs) to be compiled, and the running statistics of compiled graphs (count of remaining graphs, locked graphs, failed graphs, done compiled graphs).</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>INFO<span class="w"> </span><span class="o">||</span>NEURON_CACHE<span class="o">||</span>:<span class="w"> </span>Compile<span class="w"> </span>cache<span class="w"> </span>path:<span class="w"> </span>/var/tmp/neuron-compile-cache INFO<span class="w"> </span><span class="o">||</span>NEURON_CACHE<span class="o">||</span>:<span class="w"> </span>Current<span class="w"> </span>remaining<span class="w"> </span>items<span class="w"> </span>are<span class="w"> </span><span class="m">5</span>,<span class="w"> </span>locked<span class="w"> </span>are<span class="w"> </span><span class="m">0</span>,<span class="w"> </span>failed<span class="w"> </span>are<span class="w"> </span><span class="m">0</span>,<span class="w"> </span><span class="k">done</span><span class="w"> </span>are<span class="w"> </span><span class="m">0</span>,<span class="w"> </span>total<span class="w"> </span>is<span class="w"> </span><span class="m">5</span> INFO<span class="w"> </span><span class="o">||</span>NEURON_PARALLEL_COMPILE<span class="o">||</span>:<span class="w"> </span>master<span class="w"> </span>grab<span class="w"> </span>hlos<span class="w"> </span>to<span class="w"> </span>compile:<span class="w"> </span><span class="o">[</span><span class="s1">'/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_8068656800389078395+abb26765/model.hlo.pb'</span>,<span class="w"> </span><span class="s1">'/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_17109392703413819652+abb26765/model.hlo.pb'</span>,<span class="w"> </span><span class="s1">'/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_9219523464496887986+abb26765/model.hlo.pb'</span>,<span class="w"> </span><span class="s1">'/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_16969875447143373016+abb26765/model.hlo.pb'</span>,<span class="w"> </span><span class="s1">'/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_3000743782456078279+abb26765/model.hlo.pb'</span><span class="o">]</span> ... INFO<span class="w"> </span><span class="o">||</span>NEURON_CACHE<span class="o">||</span>:<span class="w"> </span>Current<span class="w"> </span>remaining<span class="w"> </span>items<span class="w"> </span>are<span class="w"> </span><span class="m">0</span>,<span class="w"> </span>locked<span class="w"> </span>are<span class="w"> </span><span class="m">0</span>,<span class="w"> </span>failed<span class="w"> </span>are<span class="w"> </span><span class="m">0</span>,<span class="w"> </span><span class="k">done</span><span class="w"> </span>are<span class="w"> </span><span class="m">5</span>,<span class="w"> </span>total<span class="w"> </span>is<span class="w"> </span><span class="m">5</span> </pre></div> </div> <p>After all compilations are completed, a compilation summary is shown:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>INFO:<span class="w"> </span><span class="m">2023</span>-08-24<span class="w"> </span><span class="m">20</span>:21:11.000895:<span class="w"> </span><span class="m">161136</span><span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NEURON_PARALLEL_COMPILE<span class="o">||</span>:<span class="w"> </span><span class="o">{</span> INFO:<span class="w"> </span><span class="s2">"compilation_summary"</span>:<span class="w"> </span><span class="o">{</span> INFO:<span class="w"> </span><span class="s2">"true"</span>:<span class="w"> </span><span class="m">2</span> INFO:<span class="w"> </span><span class="o">}</span>, INFO:<span class="w"> </span><span class="s2">"compilation_report"</span>:<span class="w"> </span><span class="o">{</span> INFO:<span class="w"> </span><span class="s2">"/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_1970132581169579119+abb26765/model.hlo.pb"</span>:<span class="w"> </span><span class="o">{</span> INFO:<span class="w"> </span><span class="s2">"status"</span>:<span class="w"> </span>true, INFO:<span class="w"> </span><span class="s2">"retry"</span>:<span class="w"> </span><span class="m">0</span> INFO:<span class="w"> </span><span class="o">}</span>, INFO:<span class="w"> </span><span class="s2">"/var/tmp/neuron-compile-cache/neuronxcc-2.0.0.22266a0+a69f71e55/MODULE_16141953836240613513+abb26765/model.hlo.pb"</span>:<span class="w"> </span><span class="o">{</span> INFO:<span class="w"> </span><span class="s2">"status"</span>:<span class="w"> </span>true, INFO:<span class="w"> </span><span class="s2">"retry"</span>:<span class="w"> </span><span class="m">0</span> INFO:<span class="w"> </span><span class="o">}</span> INFO:<span class="w"> </span><span class="o">}</span> INFO:<span class="w"> </span><span class="o">}</span> INFO:<span class="w"> </span><span class="m">2023</span>-08-24<span class="w"> </span><span class="m">20</span>:21:11.000895:<span class="w"> </span><span class="m">161136</span><span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NEURON_PARALLEL_COMPILE<span class="o">||</span>:<span class="w"> </span>Total<span class="w"> </span>graphs:<span class="w"> </span><span class="m">2</span> INFO:<span class="w"> </span><span class="m">2023</span>-08-24<span class="w"> </span><span class="m">20</span>:21:11.000895:<span class="w"> </span><span class="m">161136</span><span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NEURON_PARALLEL_COMPILE<span class="o">||</span>:<span class="w"> </span>Total<span class="w"> </span>successful<span class="w"> </span>compilations:<span class="w"> </span><span class="m">2</span> INFO:<span class="w"> </span><span class="m">2023</span>-08-24<span class="w"> </span><span class="m">20</span>:21:11.000895:<span class="w"> </span><span class="m">161136</span><span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NEURON_PARALLEL_COMPILE<span class="o">||</span>:<span class="w"> </span>Total<span class="w"> </span>failed<span class="w"> </span>compilations:<span class="w"> </span><span class="m">0</span> </pre></div> </div> <p>Now if you run your script (without <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code>), it will be faster since the compiled graphs are already cached.</p> <p><code class="docutils literal notranslate"><span class="pre">torchrun</span> <span class="pre">--nproc_per_node=2</span> <span class="pre">&lt;train</span> <span class="pre">script&gt;</span></code></p> <p><code class="docutils literal notranslate"><span class="pre">Note</span></code>: Except for the option to limit number of run steps (such as <code class="docutils literal notranslate"><span class="pre">--steps_this_run</span></code>), the other options of <code class="docutils literal notranslate"><span class="pre">&lt;run</span> <span class="pre">commands&gt;</span></code> must match between the pre-compilation and actual run. If this is not the case, you may see additional compilations during training run because of new graphs getting generated, resulting in cache miss.</p> <p>There may be additional compilations due to unreached execution paths (in case the execution path is not reached in the first few steps of graph extraction), or changes in parameters such as number of data parallel workers.</p> <p>Each precompilation command or actual script execution command above can be prefixed with <code class="docutils literal notranslate"><span class="pre">NEURON_COMPILE_CACHE_URL=&lt;cache</span> <span class="pre">URL&gt;</span></code> or <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS="--cache_dir=&lt;cache</span> <span class="pre">URL&gt;"</span></code> to specify a different cache location than the default (with <code class="docutils literal notranslate"><span class="pre">--cache_dir</span></code> taking precedence over <code class="docutils literal notranslate"><span class="pre">NEURON_COMPILE_CACHE_URL</span></code> if both are specified). Alternatively, the cache URL can also be specify in Python code using:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"--cache_dir=&lt;cache URL&gt;"</span> </pre></div> </div> <p>You need to specify the same cache URL for both the precompilation command (using <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code>) and the actual script execution command if you want the previously compiled and cached graphs to be used for actual script execution.</p> <p>The environment variables below are available to help modify <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> behavior:</p> <p><code class="docutils literal notranslate"><span class="pre">NEURON_PARALLEL_COMPILE_MAX_RETRIES</span></code> :</p> <ul class="simple"> <li><p>Set the maximum number of retries when using <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a> or <a class="reference internal" href="#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">neuron_parallel_compile</span></a>. If set to N, the tool will try compilation N more time(s) if the first graph compilation failed. Example: Set NEURON_PARALLEL_COMPILE_MAX_RETRIES=1 when precompiling on trn1.2xlarge where there’s limited host memory and CPU resources. Default is 0.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_IGNORE_TRAINING_SCRIPT_ERROR_AND_COMPILE</span></code> :</p> <ul class="simple"> <li><p>When using <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a> or <a class="reference internal" href="#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">neuron_parallel_compile</span></a> , if you want to ignore the error in training script and compile the accumulated HLO graphs, you can do so by setting this environment variable. Example: If NEURON_IGNORE_TRAINING_SCRIPT_ERROR_AND_COMPILE=1 is set when using <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code>, a crash in the training script would be ignored and the graphs collected upto the crash would be compiled.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_COMPILE_CACHE_URL</span></code>:</p> <ul class="simple"> <li><p>Set the <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a> URL or <a class="reference internal" href="#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">neuron_parallel_compile</span></a>. If starts with <code class="docutils literal notranslate"><span class="pre">s3://</span></code>, it will use AWS S3 as cache backend. Otherwise it will use local disk cache. Default is <code class="docutils literal notranslate"><span class="pre">/var/tmp/neuron-compile-cache</span></code>. If this is specified together with <code class="docutils literal notranslate"><span class="pre">cache_dir=&lt;cache_url&gt;</span></code> option via <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code>, the <code class="docutils literal notranslate"><span class="pre">--cache_dir</span></code> option takes precedence.</p></li> </ul> <div class="section" id="debugging-with-neuron-persistent-cache"> <h2>Debugging with Neuron Persistent Cache<a class="headerlink" href="#debugging-with-neuron-persistent-cache" title="Permalink to this headline">#</a></h2> <p>A graph compilation can fail because of a compilation error or an environment issue (for example, compilation is interrupted by ctrl-C). The graph would be marked as failed and subsequent rerun would encounter message like below:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Got<span class="w"> </span>a<span class="w"> </span>cached<span class="w"> </span>failed<span class="w"> </span>neff<span class="w"> </span>at<span class="w"> </span>/var/tmp/neuron-compile-cache/neuronxcc-2.8.0.25+a3ad0f342/MODULE_12486829708343293975+d41d8cd9/model.neff.<span class="w"> </span>Will<span class="w"> </span>skip<span class="w"> </span>compilation,<span class="w"> </span>please<span class="w"> </span><span class="nb">set</span><span class="w"> </span>--retry_failed_compilation<span class="w"> </span><span class="k">for</span><span class="w"> </span>recompilation. </pre></div> </div> <p>To retry compilation, add <code class="docutils literal notranslate"><span class="pre">--retry_failed_compilation</span></code> in <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code> environment variable. This will retry the compilation even if the graph was previously marked as failed compilation.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span> <span class="s1">' --retry_failed_compilation'</span> </pre></div> </div> <p>See <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a> for more information.</p> </div> <div class="section" id="separate-collection-and-compilation-commands"> <h2>Separate collection and compilation commands<a class="headerlink" href="#separate-collection-and-compilation-commands" title="Permalink to this headline">#</a></h2> <p>For cases like finetuning, there could be multiple independent training tasks running on different nodes and sharing many compilation graphs in common. <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> provides commands to separate the graph collection and compilation phases, so users can collect all graphs across different training sessions in advance to avoid duplicate compilations.</p> <p>To only collect the graphs from trial executions of training scripts into Neuron Persistent Cache:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>neuron_parallel_compile<span class="w"> </span>--command<span class="w"> </span>collect<span class="w"> </span>&lt;run_script&gt; </pre></div> </div> <p>To compile the graph previously collected using <code class="docutils literal notranslate"><span class="pre">collect</span></code> command and store compiled result (NEFFs) back into Neuron Persistent Cache (make sure to use the same neuronx-cc compiler version as during the graph collection step):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="sb">``</span>neuron_parallel_compile<span class="w"> </span>--command<span class="w"> </span>compile<span class="w"> </span>&lt;run_script&gt;<span class="sb">``</span> </pre></div> </div> <p>Note: if <code class="docutils literal notranslate"><span class="pre">--command</span></code> is not specified, <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> will do both collection and compilation phases by default.</p> </div> <div class="section" id="cache-maintenance-commands"> <h2>Cache maintenance commands<a class="headerlink" href="#cache-maintenance-commands" title="Permalink to this headline">#</a></h2> <p>The following commands are available to help maintain the cache.</p> <div class="admonition warning"> <p class="admonition-title">Warning</p> <p>Make sure no running process is using the cache when you use <code class="docutils literal notranslate"><span class="pre">clean</span></code> or <code class="docutils literal notranslate"><span class="pre">clear-locks</span></code> command because it can cause cache errors.</p> </div> <p>To clean cached files:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># WARNING: Make sure no running process is using the cache</span> neuron_parallel_compile<span class="w"> </span>--command<span class="w"> </span>clean </pre></div> </div> <p>To clear file locks left behind when a <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code> execution was interrupted:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># WARNING: Make sure no running process is using the cache</span> neuron_parallel_compile<span class="w"> </span>--command<span class="w"> </span>clear-locks </pre></div> </div> <p>Each command above can be prefixed with <code class="docutils literal notranslate"><span class="pre">NEURON_COMPILE_CACHE_URL=&lt;cache</span> <span class="pre">URL&gt;</span></code> or <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS="--cache_dir=&lt;cache</span> <span class="pre">URL&gt;"</span></code> to specify a different cache location than the default.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Currently there’s no automatic maintenance of cache size either on disk or in S3. Please delete files (i.e. older compiler versions) as necessary to keep cache size within your limit.</p> </div> </div> <div class="section" id="analyze-operations-support"> <h2>Analyze operations support<a class="headerlink" href="#analyze-operations-support" title="Permalink to this headline">#</a></h2> <p>The analyze command checks the support of operations within the training script by checking each operator against neuronx-cc. It is only supported for PyTorch models. The output of the tool will be available as result.json within the output location.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>neuron_parallel_compile<span class="w"> </span>--command<span class="w"> </span>analyze<span class="w"> </span>python3<span class="w"> </span>training_script.py </pre></div> </div> <p>Optional Arguments:</p> <blockquote> <div><p><code class="docutils literal notranslate"><span class="pre">--analyze-output</span> <span class="pre">ANALYZE_OUTPUT_LOCATION</span></code> Only supported for –command analyze. Path to location where output will be persisted. Default: cwd/model_analysis_result</p> <p><code class="docutils literal notranslate"><span class="pre">--analyze-verbosity</span> <span class="pre">{1,2}</span></code> Only supported for –command analyze. Level of information to be included within the output. 1: add XLA operator information into the results. 2: add aten metadata into results. Default: 2</p> </div></blockquote> <p>The tutorial for <code class="docutils literal notranslate"><span class="pre">analyze</span></code> can be found <a class="reference internal" href="../../tutorials/training/analyze_for_training.html#torch-analyze-for-training-tutorial"><span class="std std-ref">here</span></a></p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">API Reference Guide for Training (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="torch-neuron-envvars.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron Environment Variables (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:08.487Z
PyTorch Neuron Environment Variables (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html
# PyTorch Neuron Environment Variables (torch-neuronx) — AWS Neuron Documentation ## PyTorch Neuron Environment Variables (`torch-neuronx`)[#](#pytorch-neuron-environment-variables-torch-neuronx "Permalink to this headline") Environment variables allow modifications to PyTorch Neuron behavior without requiring code change to user script. It is recommended to set them in code or just before invoking the python process, such as `NEURON_FRAMEWORK_DEBUG=1 python3 <script>` to avoid inadvertently changing behavior for other scripts. Environment variables specific to PyTorch Neuron are (experimental ones are noted): `NEURON_CC_FLAGS`: - Compiler options. Full compiler options are described in the mixed-precision-casting-options. Additional options for the Neuron Persistent Cache can be found in the [Neuron Persistent Cache](../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching) guide. `NEURON_FRAMEWORK_DEBUG` **\[Experimental\]**: - Enable dumping of XLA graphs in both HLO format (intermediate representation) and text form for debugging. `NEURON_EXTRACT_GRAPHS_ONLY` **\[Experimental\]**: - Dump the XLA graphs in HLO format (intermediate representation) and execute empty stubs with zero outputs in order to allow multiple XLA graphs to be traced through a trial execution. Used automatically for ahead-of-time graph extraction for parallel compilation in [neuron\_parallel\_compile](pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli) tool. This environment variable can be checked in the training script to prevent checking of bad outputs during trial run. `NEURON_NUM_RECENT_MODELS_TO_KEEP` **\[Experimental\]**: - Keep only N number of graphs loaded in Neuron runtime for each process, where N is the value this environment variable is set to. Default is to keep all graphs loaded by a process. `NEURON_COMPILE_CACHE_URL` - Set the [Neuron Persistent Cache](../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching) URL or [neuron\_parallel\_compile](pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli). If starts with `s3://`, it will use AWS S3 as cache backend. Otherwise it will use local disk cache. Default is `/var/tmp/neuron-compile-cache`. If this is specified together with `cache_dir=<cache_url>` option via `NEURON_CC_FLAGS`, the `--cache_dir` option takes precedence. `NEURON_PARALLEL_COMPILE_MAX_RETRIES` **\[Experimental\]**: - Set the maximum number of retries when using [Neuron Persistent Cache](../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching) or [neuron\_parallel\_compile](pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli). If set to N, the tool will try compilation N more time(s) if the first graph compilation failed. Example: Set NEURON\_PARALLEL\_COMPILE\_MAX\_RETRIES=1 when precompiling on trn1.2xlarge where there’s limited host memory and CPU resources. Default is 0. `NEURON_IGNORE_TRAINING_SCRIPT_ERROR_AND_COMPILE` **\[Experimental\]**: - When using [Neuron Persistent Cache](../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching) or [neuron\_parallel\_compile](pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli) , if you want to ignore the error in training script and compile the accumulated HLO graphs, you can do so by setting this environment variable. Example: If NEURON\_IGNORE\_TRAINING\_SCRIPT\_ERROR\_AND\_COMPILE=1 is set when using `neuron_parallel_compile`, a crash in the training script would be ignored and the graphs collected upto the crash would be compiled. `NEURON_DUMP_HLO_SNAPSHOT` **\[Experimental\]**: - Dump the inputs, outputs, and graph in HLO format of a graph execution in a snapshot file. This variable can be set to `1`, `ON_NRT_ERROR`, `ON_NRT_ERROR_CPU`, `ON_NRT_ERROR_HYBRID` to dump snapshots at every iteration using CPU memory, or dump only on errors automatically using device, host, and both device and host memory respectively. `NEURON_NC0_ONLY_SNAPSHOT` **\[Experimental\]**: - Dump only the snapshot associated with Neuron Core 0 when `NEURON_NC0_ONLY_SNAPSHOT=1` and the `NEURON_DUMP_HLO_SNAPSHOT` flag is set. `NEURON_FUSE_SOFTMAX` **\[Experimental\]**: - Enable custom lowering for Softmax operation to enable compiler optimizations. `NEURON_TRANSFER_ALL_PARAMETERS_WITH_STATIC_RING` **\[Experimental\]**: - When set to 1, mark all parameter transfers as static to enable runtime optimizations for torch.nn modules that are wrapped as done in Megatron-LM. This setting is not needed if torch.nn modules are not wrapped. `BUCKET_CAP_MB` **\[PyTorch XLA\]**: - If there are many parameters, such as in BERT training, small allreduce sizes can limit performance. To improve performance, you can try increasing the bucket size using `BUCKET_CAP_MB` environment variable, which is set to 50MB by default. For example, BERT pretraining on multiple instances can see improved performance with `BUCKET_CAP_MB=512`. `XLA_USE_BF16` **\[PyTorch XLA\]**: - When `XLA_USE_BF16=1`, PyTorch Neuron will automatically map both torch.float and torch.double tensors to bfloat16 tensors and turn on Stochastic Rounding mode. This can both reduce memory footprint and improve performance. Example: to enable bfloat16 autocasting and stochastic rounding, set XLA\_USE\_BF16=1 only, as stochastic rounding mode is on by default when XLA\_USE\_BF16=1. If you would like to preserve some tensors in float32, see `XLA_DOWNCAST_BF16` below. `XLA_DOWNCAST_BF16` **\[PyTorch XLA\]**: - When `XLA_DOWNCAST_BF16=1`, PyTorch Neuron will automatically map torch.float tensors to bfloat16 tensors, torch.double tensors to float32 tensors and turn on Stochastic Rounding mode. This can both reduce memory footprint and improve performance, while preserving some tensors in float32. Example: to enable float to bfloat16 and double to float autocasting and stochastic rounding, set XLA\_DOWNCAST\_BF16=1 only, as stochastic rounding mode is on by default when XLA\_DOWNCAST\_BF16=1. If you want to cast both torch.float and torch.double to bfloat16, please see `XLA_USE_BF16` above. `NEURON_RT_STOCHASTIC_ROUNDING_EN` **\[Neuron Runtime\]**: - When `NEURON_RT_STOCHASTIC_ROUNDING_EN=1`, PyTorch Neuron will use stochastic rounding instead of round-nearest-even for all internal rounding operations when casting from FP32 to a reduced precision data type (FP16, BF16, FP8, TF32). This feature has been shown to improve training convergence for reduced precision training jobs, such as when bfloat16 autocasting is enabled. This is set to 1 by default by PyTorch Neuron when XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1. To switch to round-nearest-even mode, please set `NEURON_RT_STOCHASTIC_ROUNDING_EN=0`. `NEURON_RT_STOCHASTIC_ROUNDING_SEED` **\[Neuron Runtime\]**: - Sets the seed for the random number generator used in stochastic rounding (see previous section). If this environment variable is not set, the seed is set to 0 by default. Please set `NEURON_RT_STOCHASTIC_ROUNDING_SEED` to a fixed value to ensure reproducibility between runs. `NEURON_RT_VISIBLE_CORES` **\[Neuron Runtime\]**: > Integer range of specific NeuronCores needed by the process (for example, 0-3 specifies NeuronCores 0, 1, 2, and 3). You this environment variable when using torchrun to limit the launched processs to specific consecutive NeuronCores. To ensure best performance, the multi-core jobs requiring N NeuronCores for collective communication must be placed at the NeuronCore ID that starts at a multiple of N, where N is the world size limited to 1, 2, 8, 32. For example, a process using 2 NeuronCores can be mapped to 2 free NeuronCores starting at NeuronCore id 0, 2, 4, 6, etc, and a process using 8 NeuronCores can be mapped to 8 free NeuronCores starting at NeuronCore id 0, 8, 16, 24. Additional Neuron runtime environment variables are described in [runtime configuration documentation](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/neuron-guide/neuron-runtime/nrt-configurable-parameters.html). Additional XLA runtime environment variables are described in [PyTorch-XLA troubleshooting guide](https://github.com/pytorch/xla/blob/v1.10.0/TROUBLESHOOTING.md#user-content-environment-variables). _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron Environment Variables (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Neuron Persistent Cache" href="../../../../../general/arch/neuron-features/neuron-caching.html"> <link rel="prev" title="PyTorch Neuron neuron_parallel_compile CLI (torch-neuronx)" href="pytorch-neuron-parallel-compile.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="index.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron Environment Variables (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-environment-variables-torch-neuronx"> <span id="pytorch-neuronx-envvars"></span><h1>PyTorch Neuron Environment Variables (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#pytorch-neuron-environment-variables-torch-neuronx" title="Permalink to this headline">#</a></h1> <p>Environment variables allow modifications to PyTorch Neuron behavior without requiring code change to user script. It is recommended to set them in code or just before invoking the python process, such as <code class="docutils literal notranslate"><span class="pre">NEURON_FRAMEWORK_DEBUG=1</span> <span class="pre">python3</span> <span class="pre">&lt;script&gt;</span></code> to avoid inadvertently changing behavior for other scripts. Environment variables specific to PyTorch Neuron are (experimental ones are noted):</p> <p><code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code>:</p> <ul class="simple"> <li><p>Compiler options. Full compiler options are described in the <span class="xref std std-ref">mixed-precision-casting-options</span>. Additional options for the Neuron Persistent Cache can be found in the <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a> guide.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_FRAMEWORK_DEBUG</span></code> <strong>[Experimental]</strong>:</p> <ul class="simple"> <li><p>Enable dumping of XLA graphs in both HLO format (intermediate representation) and text form for debugging.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_EXTRACT_GRAPHS_ONLY</span></code> <strong>[Experimental]</strong>:</p> <ul class="simple"> <li><p>Dump the XLA graphs in HLO format (intermediate representation) and execute empty stubs with zero outputs in order to allow multiple XLA graphs to be traced through a trial execution. Used automatically for ahead-of-time graph extraction for parallel compilation in <a class="reference internal" href="pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">neuron_parallel_compile</span></a> tool. This environment variable can be checked in the training script to prevent checking of bad outputs during trial run.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_NUM_RECENT_MODELS_TO_KEEP</span></code> <strong>[Experimental]</strong>:</p> <ul class="simple"> <li><p>Keep only N number of graphs loaded in Neuron runtime for each process, where N is the value this environment variable is set to. Default is to keep all graphs loaded by a process.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_COMPILE_CACHE_URL</span></code></p> <ul class="simple"> <li><p>Set the <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a> URL or <a class="reference internal" href="pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">neuron_parallel_compile</span></a>. If starts with <code class="docutils literal notranslate"><span class="pre">s3://</span></code>, it will use AWS S3 as cache backend. Otherwise it will use local disk cache. Default is <code class="docutils literal notranslate"><span class="pre">/var/tmp/neuron-compile-cache</span></code>. If this is specified together with <code class="docutils literal notranslate"><span class="pre">cache_dir=&lt;cache_url&gt;</span></code> option via <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code>, the <code class="docutils literal notranslate"><span class="pre">--cache_dir</span></code> option takes precedence.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_PARALLEL_COMPILE_MAX_RETRIES</span></code> <strong>[Experimental]</strong>:</p> <ul class="simple"> <li><p>Set the maximum number of retries when using <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a> or <a class="reference internal" href="pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">neuron_parallel_compile</span></a>. If set to N, the tool will try compilation N more time(s) if the first graph compilation failed. Example: Set NEURON_PARALLEL_COMPILE_MAX_RETRIES=1 when precompiling on trn1.2xlarge where there’s limited host memory and CPU resources. Default is 0.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_IGNORE_TRAINING_SCRIPT_ERROR_AND_COMPILE</span></code> <strong>[Experimental]</strong>:</p> <ul class="simple"> <li><p>When using <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache</span></a> or <a class="reference internal" href="pytorch-neuron-parallel-compile.html#pytorch-neuronx-parallel-compile-cli"><span class="std std-ref">neuron_parallel_compile</span></a> , if you want to ignore the error in training script and compile the accumulated HLO graphs, you can do so by setting this environment variable. Example: If NEURON_IGNORE_TRAINING_SCRIPT_ERROR_AND_COMPILE=1 is set when using <code class="docutils literal notranslate"><span class="pre">neuron_parallel_compile</span></code>, a crash in the training script would be ignored and the graphs collected upto the crash would be compiled.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_DUMP_HLO_SNAPSHOT</span></code> <strong>[Experimental]</strong>:</p> <ul class="simple"> <li><p>Dump the inputs, outputs, and graph in HLO format of a graph execution in a snapshot file. This variable can be set to <code class="docutils literal notranslate"><span class="pre">1</span></code>, <code class="docutils literal notranslate"><span class="pre">ON_NRT_ERROR</span></code>, <code class="docutils literal notranslate"><span class="pre">ON_NRT_ERROR_CPU</span></code>, <code class="docutils literal notranslate"><span class="pre">ON_NRT_ERROR_HYBRID</span></code> to dump snapshots at every iteration using CPU memory, or dump only on errors automatically using device, host, and both device and host memory respectively.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_NC0_ONLY_SNAPSHOT</span></code> <strong>[Experimental]</strong>:</p> <ul class="simple"> <li><p>Dump only the snapshot associated with Neuron Core 0 when <code class="docutils literal notranslate"><span class="pre">NEURON_NC0_ONLY_SNAPSHOT=1</span></code> and the <code class="docutils literal notranslate"><span class="pre">NEURON_DUMP_HLO_SNAPSHOT</span></code> flag is set.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_FUSE_SOFTMAX</span></code> <strong>[Experimental]</strong>:</p> <ul class="simple"> <li><p>Enable custom lowering for Softmax operation to enable compiler optimizations.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_TRANSFER_ALL_PARAMETERS_WITH_STATIC_RING</span></code> <strong>[Experimental]</strong>:</p> <ul class="simple"> <li><p>When set to 1, mark all parameter transfers as static to enable runtime optimizations for torch.nn modules that are wrapped as done in Megatron-LM. This setting is not needed if torch.nn modules are not wrapped.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">BUCKET_CAP_MB</span></code> <strong>[PyTorch XLA]</strong>:</p> <ul class="simple"> <li><p>If there are many parameters, such as in BERT training, small allreduce sizes can limit performance. To improve performance, you can try increasing the bucket size using <code class="docutils literal notranslate"><span class="pre">BUCKET_CAP_MB</span></code> environment variable, which is set to 50MB by default. For example, BERT pretraining on multiple instances can see improved performance with <code class="docutils literal notranslate"><span class="pre">BUCKET_CAP_MB=512</span></code>.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">XLA_USE_BF16</span></code> <strong>[PyTorch XLA]</strong>:</p> <ul class="simple"> <li><p>When <code class="docutils literal notranslate"><span class="pre">XLA_USE_BF16=1</span></code>, PyTorch Neuron will automatically map both torch.float and torch.double tensors to bfloat16 tensors and turn on Stochastic Rounding mode. This can both reduce memory footprint and improve performance. Example: to enable bfloat16 autocasting and stochastic rounding, set XLA_USE_BF16=1 only, as stochastic rounding mode is on by default when XLA_USE_BF16=1. If you would like to preserve some tensors in float32, see <code class="docutils literal notranslate"><span class="pre">XLA_DOWNCAST_BF16</span></code> below.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">XLA_DOWNCAST_BF16</span></code> <strong>[PyTorch XLA]</strong>:</p> <ul class="simple"> <li><p>When <code class="docutils literal notranslate"><span class="pre">XLA_DOWNCAST_BF16=1</span></code>, PyTorch Neuron will automatically map torch.float tensors to bfloat16 tensors, torch.double tensors to float32 tensors and turn on Stochastic Rounding mode. This can both reduce memory footprint and improve performance, while preserving some tensors in float32. Example: to enable float to bfloat16 and double to float autocasting and stochastic rounding, set XLA_DOWNCAST_BF16=1 only, as stochastic rounding mode is on by default when XLA_DOWNCAST_BF16=1. If you want to cast both torch.float and torch.double to bfloat16, please see <code class="docutils literal notranslate"><span class="pre">XLA_USE_BF16</span></code> above.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_RT_STOCHASTIC_ROUNDING_EN</span></code> <strong>[Neuron Runtime]</strong>:</p> <ul class="simple"> <li><p>When <code class="docutils literal notranslate"><span class="pre">NEURON_RT_STOCHASTIC_ROUNDING_EN=1</span></code>, PyTorch Neuron will use stochastic rounding instead of round-nearest-even for all internal rounding operations when casting from FP32 to a reduced precision data type (FP16, BF16, FP8, TF32). This feature has been shown to improve training convergence for reduced precision training jobs, such as when bfloat16 autocasting is enabled. This is set to 1 by default by PyTorch Neuron when XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1. To switch to round-nearest-even mode, please set <code class="docutils literal notranslate"><span class="pre">NEURON_RT_STOCHASTIC_ROUNDING_EN=0</span></code>.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_RT_STOCHASTIC_ROUNDING_SEED</span></code> <strong>[Neuron Runtime]</strong>:</p> <ul class="simple"> <li><p>Sets the seed for the random number generator used in stochastic rounding (see previous section). If this environment variable is not set, the seed is set to 0 by default. Please set <code class="docutils literal notranslate"><span class="pre">NEURON_RT_STOCHASTIC_ROUNDING_SEED</span></code> to a fixed value to ensure reproducibility between runs.</p></li> </ul> <p><code class="docutils literal notranslate"><span class="pre">NEURON_RT_VISIBLE_CORES</span></code> <strong>[Neuron Runtime]</strong>:</p> <blockquote> <div><p>Integer range of specific NeuronCores needed by the process (for example, 0-3 specifies NeuronCores 0, 1, 2, and 3). You this environment variable when using torchrun to limit the launched processs to specific consecutive NeuronCores. To ensure best performance, the multi-core jobs requiring N NeuronCores for collective communication must be placed at the NeuronCore ID that starts at a multiple of N, where N is the world size limited to 1, 2, 8, 32. For example, a process using 2 NeuronCores can be mapped to 2 free NeuronCores starting at NeuronCore id 0, 2, 4, 6, etc, and a process using 8 NeuronCores can be mapped to 8 free NeuronCores starting at NeuronCore id 0, 8, 16, 24.</p> </div></blockquote> <p>Additional Neuron runtime environment variables are described in <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/neuron-guide/neuron-runtime/nrt-configurable-parameters.html">runtime configuration documentation</a>.</p> <p>Additional XLA runtime environment variables are described in <a class="reference external" href="https://github.com/pytorch/xla/blob/v1.10.0/TROUBLESHOOTING.md#user-content-environment-variables">PyTorch-XLA troubleshooting guide</a>.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="pytorch-neuron-parallel-compile.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron neuron_parallel_compile CLI (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../../../general/arch/neuron-features/neuron-caching.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Neuron Persistent Cache</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:08.642Z
How to debug models in PyTorch Neuron (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html
# How to debug models in PyTorch Neuron (torch-neuronx) — AWS Neuron Documentation ## How to debug models in PyTorch Neuron (`torch-neuronx`)[#](#how-to-debug-models-in-pytorch-neuron-torch-neuronx "Permalink to this headline") Table of Contents - [**Printing Metrics**](#printing-metrics) - [**Printing Tensors**](#printing-tensors) - [**Use mark\_step**](#use-mark-step) - [**Using Eager Debug Mode**](#using-eager-debug-mode) - [**Profiling Model Run**](#profiling-model-run) - [**Snapshotting**](#snapshotting) - [**Snapshot FAQs:**](#snapshot-faqs) Torch-XLA evaluates operations lazily, which means it builds a symbolic graph in the background and the graph is executed in hardware only when the users request (print) for the output or a mark\_step is encountered. To effectively debug training scripts with torch-xla, please use one of the approaches mentioned below: ## [**Printing Metrics**](#id1)[#](#printing-metrics "Permalink to this headline") Torch-xla provides a utility that records metrics of different sections of the code. These metrics can help figure out things like: How much time is spent in compilation? How much time is spent in execution? To check the metrics: 1. Import metrics: `import torch_xla.debug.metrics as met` 2. Print metrics at the end of the step: `print(met.metrics_report())` Printing metrics should produce an output that looks like this: ``` Metric: CompileTime TotalSamples: 1 Accumulator: 09s969ms486.408us Percentiles: 1%=09s969ms486.408us; 5%=09s969ms486.408us; 10%=09s969ms486.408us; 20%=09s969ms486.408us; 50%=09s969ms486.408us; 80%=09s969ms486.408us; 90%=09s969ms486.408us; 95%=09s969ms486.408us; 99%=09s969ms486.408us ..... Metric: ExecuteTime TotalSamples: 1 Accumulator: 186ms062.970us Percentiles: 1%=186ms062.970us; 5%=186ms062.970us; 10%=186ms062.970us; 20%=186ms062.970us; 50%=186ms062.970us; 80%=186ms062.970us; 90%=186ms062.970us; 95%=186ms062.970us; 99%=186ms062.970us .... Metric: TensorsGraphSize TotalSamples: 1 Accumulator: 9.00 Percentiles: 1%=9.00; 5%=9.00; 10%=9.00; 20%=9.00; 50%=9.00; 80%=9.00; 90%=9.00; 95%=9.00; 99%=9.00 Metric: TransferFromServerTime TotalSamples: 2 Accumulator: 010ms130.597us ValueRate: 549ms937.108us / second Rate: 108.372 / second Percentiles: 1%=004ms948.602us; 5%=004ms948.602us; 10%=004ms948.602us; 20%=004ms948.602us; 50%=006ms181.995us; 80%=006ms181.995us; 90%=006ms181.995us; 95%=006ms181.995us; 99%=006ms181.995us Metric: TransferToServerTime TotalSamples: 6 Accumulator: 061ms698.791us ValueRate: 007ms731.182us / second Rate: 0.665369 / second Percentiles: 1%=006ms848.579us; 5%=006ms848.579us; 10%=006ms848.579us; 20%=007ms129.666us; 50%=008ms940.718us; 80%=008ms496.166us; 90%=024ms636.413us; 95%=024ms636.413us; 99%=024ms636.413us Metric: TransferToServerTransformTime TotalSamples: 6 Accumulator: 011ms835.717us ValueRate: 001ms200.844us / second Rate: 0.664936 / second Percentiles: 1%=108.403us; 5%=108.403us; 10%=108.403us; 20%=115.676us; 50%=167.399us; 80%=516.659us; 90%=010ms790.400us; 95%=010ms790.400us; 99%=010ms790.400us ..... Counter: xla::_copy_from Value: 7 Counter: xla::addmm Value: 2 Counter: xla::empty Value: 5 Counter: xla::t Value: 2 .... Metric: XrtCompile TotalSamples: 1 Accumulator: 09s946ms607.609us Mean: 09s946ms607.609us StdDev: 000.000us Percentiles: 25%=09s946ms607.609us; 50%=09s946ms607.609us; 80%=09s946ms607.609us; 90%=09s946ms607.609us; 95%=09s946ms607.609us; 99%=09s946ms607.609us Metric: XrtExecute TotalSamples: 1 Accumulator: 176ms932.067us Mean: 176ms932.067us StdDev: 000.000us Percentiles: 25%=176ms932.067us; 50%=176ms932.067us; 80%=176ms932.067us; 90%=176ms932.067us; 95%=176ms932.067us; 99%=176ms932.067us Metric: XrtReadLiteral TotalSamples: 2 Accumulator: 608.578us Mean: 304.289us StdDev: 067.464us Rate: 106.899 / second Percentiles: 25%=236.825us; 50%=371.753us; 80%=371.753us; 90%=371.753us; 95%=371.753us; 99%=371.753us ``` As seen, you can get useful information about graph compile times/execution times. You can also know which operators are present in the graph, which operators are run on the CPU and which operators are run on an XLA device. For example, operators that have a prefix `aten::` would run on the CPU, since they do not have xla lowering. All operators with prefix `xla::` would run on an XLA device. Note: aten operators that do not have xla lowering would result in a graph fragmentation and might end up slowing down the entire execution. If you encounter such operators, create a request for operator support. ## [**Printing Tensors**](#id2)[#](#printing-tensors "Permalink to this headline") Users can print tensors in their script as below: ``` import os import torch import torch_xla import torch_xla.core.xla_model as xm device = xm.xla_device() input1 = torch.randn(2,10).to(device) # Defining 2 linear layers linear1 = torch.nn.Linear(10,30).to(device) linear2 = torch.nn.Linear(30,20).to(device) # Running forward output1 = linear1(input1) output2 = linear2(output1) print(output2) ``` Since torch-xla evaluates operations lazily, when you try to print `output2` , the graph associated with the tensor would be evaluated. When a graph is evaluated, it is first compiled for the device and executed on the selected device. Note: Each tensor would have a graph associated with it and can result in graph compilations and executions. For example, in the above script, if you try to print `output1` , a new graph is cut and you would see another evaluation. To avoid multiple evaluations, you can make use of `mark_step` (next section). ## [**Use mark\_step**](#id3)[#](#use-mark-step "Permalink to this headline") Torch-XLA provides an api called `mark_step` which evaluates a graph collected upto that point. While this is similar to printing of an output tensor wherein a graph is also evaluated, there is a difference. When an output tensor is printed, only the graph associated with that specific tensor is evaluated, whereas mark\_step enables all the output tensors up to `mark_step` call to be evaluated in a single graph. Hence, any tensor print after `mark_step` would be effectively free of cost as the tensor values are already evaluated. Consider the example below: ``` import os import torch import torch_xla import torch_xla.core.xla_model as xm import torch_xla.debug.metrics as met device = xm.xla_device() input1 = torch.randn(2,10).to(device) # Defining 2 linear layers linear1 = torch.nn.Linear(10,30).to(device) linear2 = torch.nn.Linear(30,20).to(device) # Running forward output1 = linear1(input1) output2 = linear2(output1) xm.mark_step() print(output2) print(output1) # Printing the metrics to check if compilation and execution occurred print(met.metrics_report()) ``` In the printed metrics, the number of compiles and executions is only 1, even though 2 tensors are printed. Hence, to avoid multiple graph evaluations, it is recommended that you visualize tensors after a `mark_step` . You can also make use of the [add\_step\_closure](https://pytorch.org/xla/release/1.9/index.html#torch_xla.core.xla_model.add_step_closure) api for this purpose. With this api, you pass in the tensors that needs to be visualized/printed. The added tensors would then be preserved in the graph and can be printed as part of the callback function passed to the api. Here is a sample usage: [https://github.com/pytorch/xla/blob/master/test/test\_train\_mp\_mnist.py#L133](https://github.com/pytorch/xla/blob/master/test/test_train_mp_mnist.py#L133) **Note:** Graph compilations can take time as the compiler optimizes the graph to run on device. ## [**Using Eager Debug Mode**](#id4)[#](#using-eager-debug-mode "Permalink to this headline") Eager debug mode provides a convenient utility to step through the code and evaluate operators one by one for correctness. Eager debug mode is useful to inspect your models the way you would do in eager-mode frameworks like PyTorch and Tensorflow. With Eager Debug Mode operations are executed eagerly. As soon as an operation is registered with torch-xla, it would be sent for compilation and execution. Since compiling a single operation, the time spent would be minimal. Moreover, the chances of hitting the framework compilation cache increases as models would have repeated operations throughout. Consider example 1 below: ``` # Example 1 import os # You need to set this env variable before importing torch-xla # to run in eager debug mode. os.environ["NEURON_USE_EAGER_DEBUG_MODE"] = "1" import torch import torch_xla import torch_xla.core.xla_model as xm import torch_xla.debug.metrics as met device = xm.xla_device() input1 = torch.randn(2,10).to(device) # Defining 2 linear layers linear1 = torch.nn.Linear(10,30).to(device) linear2 = torch.nn.Linear(30,20).to(device) # Running forward output1 = linear1(input1) output2 = linear2(output1) # Printing the metrics to check if compilation and execution occurred # Here, in the metrics you should notice that the XRTCompile and XRTExecute # value is non-zero, even though no tensor is printed. This is because, each # operation is executed eagerly. print(met.metrics_report()) print(output2) print(output1) # Printing the metrics to check if compilation and execution occurred. # Here the XRTCompile count should be same as the previous count. # In other words, printing tensors did not incur any extra compile # and execution of the graph print(met.metrics_report()) ``` As seen from the above scripts, each operator is evaluated eagerly and there is no extra compilation when output tensors are printed. Moreover, together with the on-disk Neuron persistent cache, eager debug mode only incurs one time compilation cost when the ops is first run. When the script is run again, the compiled ops will be pulled from the persistent cache. Any changes you make to the training script would result in the re-compilation of only the newly inserted operations. This is because each operation is compiled independently. Consider example 2 below: ``` # Example 2 import os # You need to set this env variable before importing torch-xla # to run in eager debug mode. os.environ["NEURON_USE_EAGER_DEBUG_MODE"] = "1" import torch import torch_xla import torch_xla.core.xla_model as xm import torch_xla.debug.metrics as met os.environ['NEURON_CC_FLAGS'] = "--log_level=INFO" device = xm.xla_device() input1 = torch.randn(2,10).to(device) # Defining 2 linear layers linear1 = torch.nn.Linear(10,30).to(device) linear2 = torch.nn.Linear(30,20).to(device) linear3 = torch.nn.Linear(20,30).to(device) linear4 = torch.nn.Linear(30,20).to(device) # Running forward output1 = linear1(input1) output2 = linear2(output1) output3 = linear3(output2) # Note the number of compiles at this point and compare # with the compiles in the next metrics print print(met.metrics_report()) output4 = linear4(output3) print(met.metrics_report()) ``` Running the above example 2 script after running example 1 script, you may notice that from the start until the statement `output2 = linear2(output1)` , all the graphs would hit the persistent cache. Executing the line `output3 = linear3(output2)` would result in a new compilation for `linear3` layer only because the layer configuration is new. Now, when we run `output4 = linear4(output3)` , you would observe no new compilation happens. This is because the graph for `linear4` is same as the graph for `linear2` and hence the compiled graph for `linear2` is reused for `linear4` by the framework’s internal cache. Eager debug mode avoids the wait times involved with tensor printing because of larger graph compilation. It is designed only for debugging purposes, so when the training script is ready, please remove the `NEURON_USE_EAGER_DEBUG_MODE` environment variable from the script in order to obtain optimal performance. By default, in eager debug mode the logging level in the Neuron compiler is set to error mode. Hence, no logs would be generated unless there is an error. Before your first print, if there are many operations that needs to be compiled, there might be a small delay. In case you want to check the logs, switch on the `INFO` logs for compiler using: ``` os.environ["NEURON_CC_FLAGS"] = "--log_level=INFO" ``` ## [**Profiling Model Run**](#id5)[#](#profiling-model-run "Permalink to this headline") Profiling model run can help to identify different bottlenecks and resolve issues faster. You can profile different sections of the code to see which block is the slowest. To profile model run, you can follow the steps below: 1. Add: `import torch_xla.debug.profiler as xp` 2. Start server. This can be done by adding the following line after creating xla device: `server = xp.start_server(9012)` 3. In a separate terminal, start tensorboard. The logdir should be in the same directory from which you run the script. ![Image: tensorboard.png](../../../../../_images/tensorboard.png) Open the tensorboard on a browser. Go to profile section in the top right. Note: you may have to install the profile plugin using: `pip install tensorboard-plugin-profile` 4. When you click on the profile, it should give an option to capture profile. Clicking on capture profile produces the following pop-up. ![Image: popup.png](../../../../../_images/popup.png) In the URL enter: `localhost:9012` . Port in this URL should be same as the one you gave when starting the server in the script. 5. Once done, click capture and it should automatically load the following page: ![Image: tb_1.png](../../../../../_images/tb_1.png) 6. To check the profile for different blocks of code, head to `trace_viewer` under `Tools` (on the left column). ![Image: options.png](../../../../../_images/options.png) 7. It should show a profile that looks like this: ![Image: profile_large.png](../../../../../_images/profile_large.png) Note: By default, torch-xla would time different blocks of code inside the library. However, you can also profile block of code in your scripts. This can be done by adding the code within a `xp.Trace` context as follows: ``` .... for epoch in range(total_epochs): inputs = torch.randn(1,10).to(device) labels = torch.tensor([1]).to(device) with xp.Trace("model_build"): loss = model(inputs, labels) with xp.Trace("loss_backward"): loss.backward() .... ``` It should produce a profile that has the `model_build` and `loss_backward` section timed. This way you can time any block of script for debugging. ![Image: Screen profile_zoom.png](../../../../../_images/profile_zoom.png) Note: If you are running your training script in a docker container, to view the tensorboard, you should launch the docker container using flag: `--network host` eg. `docker run --network host my_image:my_tag` ## [**Snapshotting**](#id6)[#](#snapshotting "Permalink to this headline") Snapshotting models can be used to dump debug information that can then be sent to the Neuron team. Neuron execution relies on a series of compiled graphs. Internally, graph HLOs are used as an intermediate representation which is then compiled. Then, during execution, the graph inputs are passed to the Neuron runtime, which produces outputs using the compiled graph. Snapshotting saves the inputs to a graph execution, executes the graphs, saves the outputs of the execution, and then bundles and dumps the inputs, outputs and graph HLO in one file. This is illustrated here: ![Image: snapshot-diagram.png](../../../../../_images/snapshot-diagram.png) This feature can be enabled using the following environment variables, which can be set at the beginning of your script as follows. ``` .... os.environ["XLA_FLAGS"] = " --xla_dump_to=dump" os.environ["NEURON_FRAMEWORK_DEBUG"] = "1" os.environ["NEURON_DUMP_HLO_SNAPSHOT"] = "1" .... ``` This set of environment variables will produce snapshots under the dump folder with the extensions `.hlo.snapshot.pb` or `.decomposed_hlo_snapshot` at every iteration. For example a file that looks like the following would be produced. ``` dump/module_SyncTensorsGraph.387.pid_12643.execution_7496.hlo_snapshot.pb ``` The dumping environment variable can be set and unset at specific iterations as shown in the following example. ``` .... for step in range(STEPS): if step == 20: os.environ["NEURON_DUMP_HLO_SNAPSHOT"] = "1" else: os.environ.pop('NEURON_DUMP_HLO_SNAPSHOT', None) train_x = torch.randn(BATCH_SIZE, 28, 28) train_x = train_x.to(device) loss = model(train_x) loss.backward() optimizer.step() xm.mark_step() .... ``` Additionally, we provide capabilities to snapshot graphs automatically. The environment variables above can be set as follows: ``` .... os.environ["XLA_FLAGS"] = " --xla_dump_to=dump" os.environ["NEURON_FRAMEWORK_DEBUG"] = "1" os.environ["NEURON_DUMP_HLO_SNAPSHOT"] = "ON_NRT_ERROR" .... ``` When unexpected errors such as a graph execution producing NaNs occurs, snapshots will be automatically produced and execution will be terminated. Occasionally, for larger models, automatic snapshotting may not capture snapshots due to the device memory being exhausted. In this case, the above flag can be set to `os.environ["NEURON_DUMP_HLO_SNAPSHOT"] = "ON_NRT_ERROR_HYBRID"`, this will allocate memory for inputs on both the device and host memory. In some additional cases, this may still go out of memory and may need to be set to `os.environ["NEURON_DUMP_HLO_SNAPSHOT"] = "ON_NRT_ERROR_CPU"` to avoid allocating any memory on the device at all for automatic snapshotting. ### [**Snapshot FAQs:**](#id7)[#](#snapshot-faqs "Permalink to this headline") **When should I use this features?** This feature should be used when debugging errors that requires interfacing with and providing debug data to the Neuron team. Snapshotting may be redundant and unnecessary in some situations. For example, when only the model weights are necessary for debugging, methods such as checkpointing may be more convenient to use. **What sort of data is captured with these snapshots?** The type of data captured by these snapshots may include model graphs in HLO form, weights/parameters, optimizer states, intermediate tensors and gradients. This data may be considered sensitive and this should be taken into account before sending the data to the Neuron team. **What is the size of these snapshots?** The size of snapshots can be significant for larger models such as GPT or BERT with several GBs worth of data for larger graphs, so it is recommended to check that sufficient disk space exists before using snapshotting. In addition, limiting the amount of snapshots taken in a run will help to preserve disk space. **Will snapshotting add overhead to my execution?** Snapshotting does add a small overhead to the execution in most cases. This overhead can be significant if snapshots are dumped at every iteration. In order to alleviate some of this overhead, in the case that snapshotting is not necessary on all cores the following environment variable can be set to collect snapshots only on the first core. In addition, checkpointing in tandem with snapshotting can be useful to reduce overhead. A checkpoint close to the problem iteration can be captured, then execution resumed with snapshots enabled. ``` .... os.environ["NEURON_NC0_ONLY_SNAPSHOT"] = "1" .... ``` **How can I share snapshots with the Neuron team?** These snapshots can be shared with the Neuron team via S3 bucket. _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>How to debug models in PyTorch Neuron (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Developer Guide for Profiling with PyTorch Neuron (torch-neuronx)" href="../torch-neuronx-profiling-dev-guide.html"> <link rel="prev" title="Developer Guide for Training with PyTorch Neuron (torch-neuronx)" href="pytorch-neuron-programming-guide.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="index.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#printing-metrics"> <strong> Printing Metrics </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#printing-tensors"> <strong> Printing Tensors </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#use-mark-step"> <strong> Use mark_step </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#using-eager-debug-mode"> <strong> Using Eager Debug Mode </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#profiling-model-run"> <strong> Profiling Model Run </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#snapshotting"> <strong> Snapshotting </strong> </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#snapshot-faqs"> <strong> Snapshot FAQs: </strong> </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>How to debug models in PyTorch Neuron (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#printing-metrics"> <strong> Printing Metrics </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#printing-tensors"> <strong> Printing Tensors </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#use-mark-step"> <strong> Use mark_step </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#using-eager-debug-mode"> <strong> Using Eager Debug Mode </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#profiling-model-run"> <strong> Profiling Model Run </strong> </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#snapshotting"> <strong> Snapshotting </strong> </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#snapshot-faqs"> <strong> Snapshot FAQs: </strong> </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="how-to-debug-models-in-pytorch-neuron-torch-neuronx"> <span id="pytorch-neuronx-debug"></span><h1>How to debug models in PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#how-to-debug-models-in-pytorch-neuron-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#printing-metrics" id="id1"><strong>Printing Metrics</strong></a></p></li> <li><p><a class="reference internal" href="#printing-tensors" id="id2"><strong>Printing Tensors</strong></a></p></li> <li><p><a class="reference internal" href="#use-mark-step" id="id3"><strong>Use mark_step</strong></a></p></li> <li><p><a class="reference internal" href="#using-eager-debug-mode" id="id4"><strong>Using Eager Debug Mode</strong></a></p></li> <li><p><a class="reference internal" href="#profiling-model-run" id="id5"><strong>Profiling Model Run</strong></a></p></li> <li><p><a class="reference internal" href="#snapshotting" id="id6"><strong>Snapshotting</strong></a></p> <ul> <li><p><a class="reference internal" href="#snapshot-faqs" id="id7"><strong>Snapshot FAQs:</strong></a></p></li> </ul> </li> </ul> </div> <p>Torch-XLA evaluates operations lazily, which means it builds a symbolic graph in the background and the graph is executed in hardware only when the users request (print) for the output or a mark_step is encountered. To effectively debug training scripts with torch-xla, please use one of the approaches mentioned below:</p> <div class="section" id="printing-metrics"> <h2><a class="toc-backref" href="#id1"><strong>Printing Metrics</strong></a><a class="headerlink" href="#printing-metrics" title="Permalink to this headline">#</a></h2> <p>Torch-xla provides a utility that records metrics of different sections of the code. These metrics can help figure out things like: How much time is spent in compilation? How much time is spent in execution? To check the metrics:</p> <ol class="arabic simple"> <li><p>Import metrics: <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">torch_xla.debug.metrics</span> <span class="pre">as</span> <span class="pre">met</span></code></p></li> <li><p>Print metrics at the end of the step: <code class="docutils literal notranslate"><span class="pre">print(met.metrics_report())</span></code></p></li> </ol> <p>Printing metrics should produce an output that looks like this:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Metric:<span class="w"> </span>CompileTime <span class="w"> </span>TotalSamples:<span class="w"> </span><span class="m">1</span> <span class="w"> </span>Accumulator:<span class="w"> </span>09s969ms486.408us <span class="w"> </span>Percentiles:<span class="w"> </span><span class="m">1</span>%<span class="o">=</span>09s969ms486.408us<span class="p">;</span><span class="w"> </span><span class="m">5</span>%<span class="o">=</span>09s969ms486.408us<span class="p">;</span><span class="w"> </span><span class="m">10</span>%<span class="o">=</span>09s969ms486.408us<span class="p">;</span><span class="w"> </span><span class="m">20</span>%<span class="o">=</span>09s969ms486.408us<span class="p">;</span><span class="w"> </span><span class="m">50</span>%<span class="o">=</span>09s969ms486.408us<span class="p">;</span><span class="w"> </span><span class="m">80</span>%<span class="o">=</span>09s969ms486.408us<span class="p">;</span><span class="w"> </span><span class="m">90</span>%<span class="o">=</span>09s969ms486.408us<span class="p">;</span><span class="w"> </span><span class="m">95</span>%<span class="o">=</span>09s969ms486.408us<span class="p">;</span><span class="w"> </span><span class="m">99</span>%<span class="o">=</span>09s969ms486.408us ..... Metric:<span class="w"> </span>ExecuteTime <span class="w"> </span>TotalSamples:<span class="w"> </span><span class="m">1</span> <span class="w"> </span>Accumulator:<span class="w"> </span>186ms062.970us <span class="w"> </span>Percentiles:<span class="w"> </span><span class="m">1</span>%<span class="o">=</span>186ms062.970us<span class="p">;</span><span class="w"> </span><span class="m">5</span>%<span class="o">=</span>186ms062.970us<span class="p">;</span><span class="w"> </span><span class="m">10</span>%<span class="o">=</span>186ms062.970us<span class="p">;</span><span class="w"> </span><span class="m">20</span>%<span class="o">=</span>186ms062.970us<span class="p">;</span><span class="w"> </span><span class="m">50</span>%<span class="o">=</span>186ms062.970us<span class="p">;</span><span class="w"> </span><span class="m">80</span>%<span class="o">=</span>186ms062.970us<span class="p">;</span><span class="w"> </span><span class="m">90</span>%<span class="o">=</span>186ms062.970us<span class="p">;</span><span class="w"> </span><span class="m">95</span>%<span class="o">=</span>186ms062.970us<span class="p">;</span><span class="w"> </span><span class="m">99</span>%<span class="o">=</span>186ms062.970us .... Metric:<span class="w"> </span>TensorsGraphSize <span class="w"> </span>TotalSamples:<span class="w"> </span><span class="m">1</span> <span class="w"> </span>Accumulator:<span class="w"> </span><span class="m">9</span>.00 <span class="w"> </span>Percentiles:<span class="w"> </span><span class="m">1</span>%<span class="o">=</span><span class="m">9</span>.00<span class="p">;</span><span class="w"> </span><span class="m">5</span>%<span class="o">=</span><span class="m">9</span>.00<span class="p">;</span><span class="w"> </span><span class="m">10</span>%<span class="o">=</span><span class="m">9</span>.00<span class="p">;</span><span class="w"> </span><span class="m">20</span>%<span class="o">=</span><span class="m">9</span>.00<span class="p">;</span><span class="w"> </span><span class="m">50</span>%<span class="o">=</span><span class="m">9</span>.00<span class="p">;</span><span class="w"> </span><span class="m">80</span>%<span class="o">=</span><span class="m">9</span>.00<span class="p">;</span><span class="w"> </span><span class="m">90</span>%<span class="o">=</span><span class="m">9</span>.00<span class="p">;</span><span class="w"> </span><span class="m">95</span>%<span class="o">=</span><span class="m">9</span>.00<span class="p">;</span><span class="w"> </span><span class="m">99</span>%<span class="o">=</span><span class="m">9</span>.00 Metric:<span class="w"> </span>TransferFromServerTime <span class="w"> </span>TotalSamples:<span class="w"> </span><span class="m">2</span> <span class="w"> </span>Accumulator:<span class="w"> </span>010ms130.597us <span class="w"> </span>ValueRate:<span class="w"> </span>549ms937.108us<span class="w"> </span>/<span class="w"> </span>second <span class="w"> </span>Rate:<span class="w"> </span><span class="m">108</span>.372<span class="w"> </span>/<span class="w"> </span>second <span class="w"> </span>Percentiles:<span class="w"> </span><span class="m">1</span>%<span class="o">=</span>004ms948.602us<span class="p">;</span><span class="w"> </span><span class="m">5</span>%<span class="o">=</span>004ms948.602us<span class="p">;</span><span class="w"> </span><span class="m">10</span>%<span class="o">=</span>004ms948.602us<span class="p">;</span><span class="w"> </span><span class="m">20</span>%<span class="o">=</span>004ms948.602us<span class="p">;</span><span class="w"> </span><span class="m">50</span>%<span class="o">=</span>006ms181.995us<span class="p">;</span><span class="w"> </span><span class="m">80</span>%<span class="o">=</span>006ms181.995us<span class="p">;</span><span class="w"> </span><span class="m">90</span>%<span class="o">=</span>006ms181.995us<span class="p">;</span><span class="w"> </span><span class="m">95</span>%<span class="o">=</span>006ms181.995us<span class="p">;</span><span class="w"> </span><span class="m">99</span>%<span class="o">=</span>006ms181.995us Metric:<span class="w"> </span>TransferToServerTime <span class="w"> </span>TotalSamples:<span class="w"> </span><span class="m">6</span> <span class="w"> </span>Accumulator:<span class="w"> </span>061ms698.791us <span class="w"> </span>ValueRate:<span class="w"> </span>007ms731.182us<span class="w"> </span>/<span class="w"> </span>second <span class="w"> </span>Rate:<span class="w"> </span><span class="m">0</span>.665369<span class="w"> </span>/<span class="w"> </span>second <span class="w"> </span>Percentiles:<span class="w"> </span><span class="m">1</span>%<span class="o">=</span>006ms848.579us<span class="p">;</span><span class="w"> </span><span class="m">5</span>%<span class="o">=</span>006ms848.579us<span class="p">;</span><span class="w"> </span><span class="m">10</span>%<span class="o">=</span>006ms848.579us<span class="p">;</span><span class="w"> </span><span class="m">20</span>%<span class="o">=</span>007ms129.666us<span class="p">;</span><span class="w"> </span><span class="m">50</span>%<span class="o">=</span>008ms940.718us<span class="p">;</span><span class="w"> </span><span class="m">80</span>%<span class="o">=</span>008ms496.166us<span class="p">;</span><span class="w"> </span><span class="m">90</span>%<span class="o">=</span>024ms636.413us<span class="p">;</span><span class="w"> </span><span class="m">95</span>%<span class="o">=</span>024ms636.413us<span class="p">;</span><span class="w"> </span><span class="m">99</span>%<span class="o">=</span>024ms636.413us Metric:<span class="w"> </span>TransferToServerTransformTime <span class="w"> </span>TotalSamples:<span class="w"> </span><span class="m">6</span> <span class="w"> </span>Accumulator:<span class="w"> </span>011ms835.717us <span class="w"> </span>ValueRate:<span class="w"> </span>001ms200.844us<span class="w"> </span>/<span class="w"> </span>second <span class="w"> </span>Rate:<span class="w"> </span><span class="m">0</span>.664936<span class="w"> </span>/<span class="w"> </span>second <span class="w"> </span>Percentiles:<span class="w"> </span><span class="m">1</span>%<span class="o">=</span><span class="m">108</span>.403us<span class="p">;</span><span class="w"> </span><span class="m">5</span>%<span class="o">=</span><span class="m">108</span>.403us<span class="p">;</span><span class="w"> </span><span class="m">10</span>%<span class="o">=</span><span class="m">108</span>.403us<span class="p">;</span><span class="w"> </span><span class="m">20</span>%<span class="o">=</span><span class="m">115</span>.676us<span class="p">;</span><span class="w"> </span><span class="m">50</span>%<span class="o">=</span><span class="m">167</span>.399us<span class="p">;</span><span class="w"> </span><span class="m">80</span>%<span class="o">=</span><span class="m">516</span>.659us<span class="p">;</span><span class="w"> </span><span class="m">90</span>%<span class="o">=</span>010ms790.400us<span class="p">;</span><span class="w"> </span><span class="m">95</span>%<span class="o">=</span>010ms790.400us<span class="p">;</span><span class="w"> </span><span class="m">99</span>%<span class="o">=</span>010ms790.400us ..... Counter:<span class="w"> </span>xla::_copy_from <span class="w"> </span>Value:<span class="w"> </span><span class="m">7</span> Counter:<span class="w"> </span>xla::addmm <span class="w"> </span>Value:<span class="w"> </span><span class="m">2</span> Counter:<span class="w"> </span>xla::empty <span class="w"> </span>Value:<span class="w"> </span><span class="m">5</span> Counter:<span class="w"> </span>xla::t <span class="w"> </span>Value:<span class="w"> </span><span class="m">2</span> .... Metric:<span class="w"> </span>XrtCompile <span class="w"> </span>TotalSamples:<span class="w"> </span><span class="m">1</span> <span class="w"> </span>Accumulator:<span class="w"> </span>09s946ms607.609us <span class="w"> </span>Mean:<span class="w"> </span>09s946ms607.609us <span class="w"> </span>StdDev:<span class="w"> </span><span class="m">000</span>.000us <span class="w"> </span>Percentiles:<span class="w"> </span><span class="m">25</span>%<span class="o">=</span>09s946ms607.609us<span class="p">;</span><span class="w"> </span><span class="m">50</span>%<span class="o">=</span>09s946ms607.609us<span class="p">;</span><span class="w"> </span><span class="m">80</span>%<span class="o">=</span>09s946ms607.609us<span class="p">;</span><span class="w"> </span><span class="m">90</span>%<span class="o">=</span>09s946ms607.609us<span class="p">;</span><span class="w"> </span><span class="m">95</span>%<span class="o">=</span>09s946ms607.609us<span class="p">;</span><span class="w"> </span><span class="m">99</span>%<span class="o">=</span>09s946ms607.609us Metric:<span class="w"> </span>XrtExecute <span class="w"> </span>TotalSamples:<span class="w"> </span><span class="m">1</span> <span class="w"> </span>Accumulator:<span class="w"> </span>176ms932.067us <span class="w"> </span>Mean:<span class="w"> </span>176ms932.067us <span class="w"> </span>StdDev:<span class="w"> </span><span class="m">000</span>.000us <span class="w"> </span>Percentiles:<span class="w"> </span><span class="m">25</span>%<span class="o">=</span>176ms932.067us<span class="p">;</span><span class="w"> </span><span class="m">50</span>%<span class="o">=</span>176ms932.067us<span class="p">;</span><span class="w"> </span><span class="m">80</span>%<span class="o">=</span>176ms932.067us<span class="p">;</span><span class="w"> </span><span class="m">90</span>%<span class="o">=</span>176ms932.067us<span class="p">;</span><span class="w"> </span><span class="m">95</span>%<span class="o">=</span>176ms932.067us<span class="p">;</span><span class="w"> </span><span class="m">99</span>%<span class="o">=</span>176ms932.067us Metric:<span class="w"> </span>XrtReadLiteral <span class="w"> </span>TotalSamples:<span class="w"> </span><span class="m">2</span> <span class="w"> </span>Accumulator:<span class="w"> </span><span class="m">608</span>.578us <span class="w"> </span>Mean:<span class="w"> </span><span class="m">304</span>.289us <span class="w"> </span>StdDev:<span class="w"> </span><span class="m">067</span>.464us <span class="w"> </span>Rate:<span class="w"> </span><span class="m">106</span>.899<span class="w"> </span>/<span class="w"> </span>second <span class="w"> </span>Percentiles:<span class="w"> </span><span class="m">25</span>%<span class="o">=</span><span class="m">236</span>.825us<span class="p">;</span><span class="w"> </span><span class="m">50</span>%<span class="o">=</span><span class="m">371</span>.753us<span class="p">;</span><span class="w"> </span><span class="m">80</span>%<span class="o">=</span><span class="m">371</span>.753us<span class="p">;</span><span class="w"> </span><span class="m">90</span>%<span class="o">=</span><span class="m">371</span>.753us<span class="p">;</span><span class="w"> </span><span class="m">95</span>%<span class="o">=</span><span class="m">371</span>.753us<span class="p">;</span><span class="w"> </span><span class="m">99</span>%<span class="o">=</span><span class="m">371</span>.753us </pre></div> </div> <p>As seen, you can get useful information about graph compile times/execution times. You can also know which operators are present in the graph, which operators are run on the CPU and which operators are run on an XLA device. For example, operators that have a prefix <code class="docutils literal notranslate"><span class="pre">aten::</span></code> would run on the CPU, since they do not have xla lowering. All operators with prefix <code class="docutils literal notranslate"><span class="pre">xla::</span></code> would run on an XLA device. Note: aten operators that do not have xla lowering would result in a graph fragmentation and might end up slowing down the entire execution. If you encounter such operators, create a request for operator support.</p> </div> <div class="section" id="printing-tensors"> <h2><a class="toc-backref" href="#id2"><strong>Printing Tensors</strong></a><a class="headerlink" href="#printing-tensors" title="Permalink to this headline">#</a></h2> <p>Users can print tensors in their script as below:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_xla</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="n">input1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">10</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="c1"># Defining 2 linear layers</span> <span class="n">linear1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">30</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">linear2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span><span class="mi">20</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="c1"># Running forward</span> <span class="n">output1</span> <span class="o">=</span> <span class="n">linear1</span><span class="p">(</span><span class="n">input1</span><span class="p">)</span> <span class="n">output2</span> <span class="o">=</span> <span class="n">linear2</span><span class="p">(</span><span class="n">output1</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">output2</span><span class="p">)</span> </pre></div> </div> <p>Since torch-xla evaluates operations lazily, when you try to print <code class="docutils literal notranslate"><span class="pre">output2</span></code> , the graph associated with the tensor would be evaluated. When a graph is evaluated, it is first compiled for the device and executed on the selected device. Note: Each tensor would have a graph associated with it and can result in graph compilations and executions. For example, in the above script, if you try to print <code class="docutils literal notranslate"><span class="pre">output1</span></code> , a new graph is cut and you would see another evaluation. To avoid multiple evaluations, you can make use of <code class="docutils literal notranslate"><span class="pre">mark_step</span></code> (next section).</p> </div> <div class="section" id="use-mark-step"> <h2><a class="toc-backref" href="#id3"><strong>Use mark_step</strong></a><a class="headerlink" href="#use-mark-step" title="Permalink to this headline">#</a></h2> <p>Torch-XLA provides an api called <code class="docutils literal notranslate"><span class="pre">mark_step</span></code> which evaluates a graph collected upto that point. While this is similar to printing of an output tensor wherein a graph is also evaluated, there is a difference. When an output tensor is printed, only the graph associated with that specific tensor is evaluated, whereas mark_step enables all the output tensors up to <code class="docutils literal notranslate"><span class="pre">mark_step</span></code> call to be evaluated in a single graph. Hence, any tensor print after <code class="docutils literal notranslate"><span class="pre">mark_step</span></code> would be effectively free of cost as the tensor values are already evaluated. Consider the example below:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_xla</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="kn">import</span> <span class="nn">torch_xla.debug.metrics</span> <span class="k">as</span> <span class="nn">met</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="n">input1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">10</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="c1"># Defining 2 linear layers</span> <span class="n">linear1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">30</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">linear2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span><span class="mi">20</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="c1"># Running forward</span> <span class="n">output1</span> <span class="o">=</span> <span class="n">linear1</span><span class="p">(</span><span class="n">input1</span><span class="p">)</span> <span class="n">output2</span> <span class="o">=</span> <span class="n">linear2</span><span class="p">(</span><span class="n">output1</span><span class="p">)</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> <span class="nb">print</span><span class="p">(</span><span class="n">output2</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">output1</span><span class="p">)</span> <span class="c1"># Printing the metrics to check if compilation and execution occurred</span> <span class="nb">print</span><span class="p">(</span><span class="n">met</span><span class="o">.</span><span class="n">metrics_report</span><span class="p">())</span> </pre></div> </div> <p>In the printed metrics, the number of compiles and executions is only 1, even though 2 tensors are printed. Hence, to avoid multiple graph evaluations, it is recommended that you visualize tensors after a <code class="docutils literal notranslate"><span class="pre">mark_step</span></code> . You can also make use of the <a class="reference external" href="https://pytorch.org/xla/release/1.9/index.html#torch_xla.core.xla_model.add_step_closure">add_step_closure</a> api for this purpose. With this api, you pass in the tensors that needs to be visualized/printed. The added tensors would then be preserved in the graph and can be printed as part of the callback function passed to the api. Here is a sample usage: <a class="reference external" href="https://github.com/pytorch/xla/blob/master/test/test_train_mp_mnist.py#L133">https://github.com/pytorch/xla/blob/master/test/test_train_mp_mnist.py#L133</a></p> <p><strong>Note:</strong> Graph compilations can take time as the compiler optimizes the graph to run on device.</p> </div> <div class="section" id="using-eager-debug-mode"> <h2><a class="toc-backref" href="#id4"><strong>Using Eager Debug Mode</strong></a><a class="headerlink" href="#using-eager-debug-mode" title="Permalink to this headline">#</a></h2> <p>Eager debug mode provides a convenient utility to step through the code and evaluate operators one by one for correctness. Eager debug mode is useful to inspect your models the way you would do in eager-mode frameworks like PyTorch and Tensorflow. With Eager Debug Mode operations are executed eagerly. As soon as an operation is registered with torch-xla, it would be sent for compilation and execution. Since compiling a single operation, the time spent would be minimal. Moreover, the chances of hitting the framework compilation cache increases as models would have repeated operations throughout. Consider example 1 below:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Example 1</span> <span class="kn">import</span> <span class="nn">os</span> <span class="c1"># You need to set this env variable before importing torch-xla</span> <span class="c1"># to run in eager debug mode.</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_USE_EAGER_DEBUG_MODE"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_xla</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="kn">import</span> <span class="nn">torch_xla.debug.metrics</span> <span class="k">as</span> <span class="nn">met</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="n">input1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">10</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="c1"># Defining 2 linear layers</span> <span class="n">linear1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">30</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">linear2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span><span class="mi">20</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="c1"># Running forward</span> <span class="n">output1</span> <span class="o">=</span> <span class="n">linear1</span><span class="p">(</span><span class="n">input1</span><span class="p">)</span> <span class="n">output2</span> <span class="o">=</span> <span class="n">linear2</span><span class="p">(</span><span class="n">output1</span><span class="p">)</span> <span class="c1"># Printing the metrics to check if compilation and execution occurred</span> <span class="c1"># Here, in the metrics you should notice that the XRTCompile and XRTExecute</span> <span class="c1"># value is non-zero, even though no tensor is printed. This is because, each</span> <span class="c1"># operation is executed eagerly.</span> <span class="nb">print</span><span class="p">(</span><span class="n">met</span><span class="o">.</span><span class="n">metrics_report</span><span class="p">())</span> <span class="nb">print</span><span class="p">(</span><span class="n">output2</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">output1</span><span class="p">)</span> <span class="c1"># Printing the metrics to check if compilation and execution occurred.</span> <span class="c1"># Here the XRTCompile count should be same as the previous count.</span> <span class="c1"># In other words, printing tensors did not incur any extra compile</span> <span class="c1"># and execution of the graph</span> <span class="nb">print</span><span class="p">(</span><span class="n">met</span><span class="o">.</span><span class="n">metrics_report</span><span class="p">())</span> </pre></div> </div> <p>As seen from the above scripts, each operator is evaluated eagerly and there is no extra compilation when output tensors are printed. Moreover, together with the on-disk Neuron persistent cache, eager debug mode only incurs one time compilation cost when the ops is first run. When the script is run again, the compiled ops will be pulled from the persistent cache. Any changes you make to the training script would result in the re-compilation of only the newly inserted operations. This is because each operation is compiled independently. Consider example 2 below:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Example 2</span> <span class="kn">import</span> <span class="nn">os</span> <span class="c1"># You need to set this env variable before importing torch-xla</span> <span class="c1"># to run in eager debug mode.</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_USE_EAGER_DEBUG_MODE"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_xla</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="kn">import</span> <span class="nn">torch_xla.debug.metrics</span> <span class="k">as</span> <span class="nn">met</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"--log_level=INFO"</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="n">input1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">10</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="c1"># Defining 2 linear layers</span> <span class="n">linear1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">30</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">linear2</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span><span class="mi">20</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">linear3</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">30</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">linear4</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span><span class="mi">20</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="c1"># Running forward</span> <span class="n">output1</span> <span class="o">=</span> <span class="n">linear1</span><span class="p">(</span><span class="n">input1</span><span class="p">)</span> <span class="n">output2</span> <span class="o">=</span> <span class="n">linear2</span><span class="p">(</span><span class="n">output1</span><span class="p">)</span> <span class="n">output3</span> <span class="o">=</span> <span class="n">linear3</span><span class="p">(</span><span class="n">output2</span><span class="p">)</span> <span class="c1"># Note the number of compiles at this point and compare</span> <span class="c1"># with the compiles in the next metrics print</span> <span class="nb">print</span><span class="p">(</span><span class="n">met</span><span class="o">.</span><span class="n">metrics_report</span><span class="p">())</span> <span class="n">output4</span> <span class="o">=</span> <span class="n">linear4</span><span class="p">(</span><span class="n">output3</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">met</span><span class="o">.</span><span class="n">metrics_report</span><span class="p">())</span> </pre></div> </div> <p>Running the above example 2 script after running example 1 script, you may notice that from the start until the statement <code class="docutils literal notranslate"><span class="pre">output2</span> <span class="pre">=</span> <span class="pre">linear2(output1)</span></code> , all the graphs would hit the persistent cache. Executing the line <code class="docutils literal notranslate"><span class="pre">output3</span> <span class="pre">=</span> <span class="pre">linear3(output2)</span></code> would result in a new compilation for <code class="docutils literal notranslate"><span class="pre">linear3</span></code> layer only because the layer configuration is new. Now, when we run <code class="docutils literal notranslate"><span class="pre">output4</span> <span class="pre">=</span> <span class="pre">linear4(output3)</span></code> , you would observe no new compilation happens. This is because the graph for <code class="docutils literal notranslate"><span class="pre">linear4</span></code> is same as the graph for <code class="docutils literal notranslate"><span class="pre">linear2</span></code> and hence the compiled graph for <code class="docutils literal notranslate"><span class="pre">linear2</span></code> is reused for <code class="docutils literal notranslate"><span class="pre">linear4</span></code> by the framework’s internal cache.</p> <p>Eager debug mode avoids the wait times involved with tensor printing because of larger graph compilation. It is designed only for debugging purposes, so when the training script is ready, please remove the <code class="docutils literal notranslate"><span class="pre">NEURON_USE_EAGER_DEBUG_MODE</span></code> environment variable from the script in order to obtain optimal performance.</p> <p>By default, in eager debug mode the logging level in the Neuron compiler is set to error mode. Hence, no logs would be generated unless there is an error. Before your first print, if there are many operations that needs to be compiled, there might be a small delay. In case you want to check the logs, switch on the <code class="docutils literal notranslate"><span class="pre">INFO</span></code> logs for compiler using:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_CC_FLAGS"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"--log_level=INFO"</span> </pre></div> </div> </div> <div class="section" id="profiling-model-run"> <h2><a class="toc-backref" href="#id5"><strong>Profiling Model Run</strong></a><a class="headerlink" href="#profiling-model-run" title="Permalink to this headline">#</a></h2> <p>Profiling model run can help to identify different bottlenecks and resolve issues faster. You can profile different sections of the code to see which block is the slowest. To profile model run, you can follow the steps below:</p> <ol class="arabic"> <li><p>Add: <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">torch_xla.debug.profiler</span> <span class="pre">as</span> <span class="pre">xp</span></code></p></li> <li><p>Start server. This can be done by adding the following line after creating xla device: <code class="docutils literal notranslate"><span class="pre">server</span> <span class="pre">=</span> <span class="pre">xp.start_server(9012)</span></code></p></li> <li><p>In a separate terminal, start tensorboard. The logdir should be in the same directory from which you run the script.</p> <img alt="Image: tensorboard.png" src="../../../../../_images/tensorboard.png"> <p>Open the tensorboard on a browser. Go to profile section in the top right. Note: you may have to install the profile plugin using: <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">tensorboard-plugin-profile</span></code></p> </li> <li><p>When you click on the profile, it should give an option to capture profile. Clicking on capture profile produces the following pop-up.</p> <img alt="Image: popup.png" src="../../../../../_images/popup.png"> <p>In the URL enter: <code class="docutils literal notranslate"><span class="pre">localhost:9012</span></code> . Port in this URL should be same as the one you gave when starting the server in the script.</p> </li> <li><p>Once done, click capture and it should automatically load the following page:</p> <img alt="Image: tb_1.png" src="../../../../../_images/tb_1.png"> </li> <li><p>To check the profile for different blocks of code, head to <code class="docutils literal notranslate"><span class="pre">trace_viewer</span></code> under <code class="docutils literal notranslate"><span class="pre">Tools</span></code> (on the left column).</p> <img alt="Image: options.png" src="../../../../../_images/options.png"> </li> <li><p>It should show a profile that looks like this:</p> <img alt="Image: profile_large.png" src="../../../../../_images/profile_large.png"> </li> </ol> <p>Note: By default, torch-xla would time different blocks of code inside the library. However, you can also profile block of code in your scripts. This can be done by adding the code within a <code class="docutils literal notranslate"><span class="pre">xp.Trace</span></code> context as follows:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="o">....</span> <span class="k">for</span> <span class="n">epoch</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">total_epochs</span><span class="p">):</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">10</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([</span><span class="mi">1</span><span class="p">])</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="k">with</span> <span class="n">xp</span><span class="o">.</span><span class="n">Trace</span><span class="p">(</span><span class="s2">"model_build"</span><span class="p">):</span> <span class="n">loss</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">labels</span><span class="p">)</span> <span class="k">with</span> <span class="n">xp</span><span class="o">.</span><span class="n">Trace</span><span class="p">(</span><span class="s2">"loss_backward"</span><span class="p">):</span> <span class="n">loss</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span> <span class="o">....</span> </pre></div> </div> <p>It should produce a profile that has the <code class="docutils literal notranslate"><span class="pre">model_build</span></code> and <code class="docutils literal notranslate"><span class="pre">loss_backward</span></code> section timed. This way you can time any block of script for debugging.</p> <img alt="Image: Screen profile_zoom.png" src="../../../../../_images/profile_zoom.png"> <p>Note: If you are running your training script in a docker container, to view the tensorboard, you should launch the docker container using flag: <code class="docutils literal notranslate"><span class="pre">--network</span> <span class="pre">host</span></code> eg. <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">run</span> <span class="pre">--network</span> <span class="pre">host</span> <span class="pre">my_image:my_tag</span></code></p> </div> <div class="section" id="snapshotting"> <span id="torch-neuronx-snapshotting"></span><h2><a class="toc-backref" href="#id6"><strong>Snapshotting</strong></a><a class="headerlink" href="#snapshotting" title="Permalink to this headline">#</a></h2> <p>Snapshotting models can be used to dump debug information that can then be sent to the Neuron team. Neuron execution relies on a series of compiled graphs. Internally, graph HLOs are used as an intermediate representation which is then compiled. Then, during execution, the graph inputs are passed to the Neuron runtime, which produces outputs using the compiled graph. Snapshotting saves the inputs to a graph execution, executes the graphs, saves the outputs of the execution, and then bundles and dumps the inputs, outputs and graph HLO in one file. This is illustrated here:</p> <img alt="Image: snapshot-diagram.png" src="../../../../../_images/snapshot-diagram.png"> <p>This feature can be enabled using the following environment variables, which can be set at the beginning of your script as follows.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="o">....</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"XLA_FLAGS"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">" --xla_dump_to=dump"</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_FRAMEWORK_DEBUG"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_DUMP_HLO_SNAPSHOT"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span> <span class="o">....</span> </pre></div> </div> <p>This set of environment variables will produce snapshots under the dump folder with the extensions <code class="docutils literal notranslate"><span class="pre">.hlo.snapshot.pb</span></code> or <code class="docutils literal notranslate"><span class="pre">.decomposed_hlo_snapshot</span></code> at every iteration. For example a file that looks like the following would be produced.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>dump/module_SyncTensorsGraph.387.pid_12643.execution_7496.hlo_snapshot.pb </pre></div> </div> <p>The dumping environment variable can be set and unset at specific iterations as shown in the following example.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="o">....</span> <span class="k">for</span> <span class="n">step</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">STEPS</span><span class="p">):</span> <span class="k">if</span> <span class="n">step</span> <span class="o">==</span> <span class="mi">20</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_DUMP_HLO_SNAPSHOT"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span> <span class="k">else</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'NEURON_DUMP_HLO_SNAPSHOT'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="n">train_x</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="n">BATCH_SIZE</span><span class="p">,</span> <span class="mi">28</span><span class="p">,</span> <span class="mi">28</span><span class="p">)</span> <span class="n">train_x</span> <span class="o">=</span> <span class="n">train_x</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">loss</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">train_x</span><span class="p">)</span> <span class="n">loss</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">step</span><span class="p">()</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> <span class="o">....</span> </pre></div> </div> <p>Additionally, we provide capabilities to snapshot graphs automatically. The environment variables above can be set as follows:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="o">....</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"XLA_FLAGS"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">" --xla_dump_to=dump"</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_FRAMEWORK_DEBUG"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_DUMP_HLO_SNAPSHOT"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"ON_NRT_ERROR"</span> <span class="o">....</span> </pre></div> </div> <p>When unexpected errors such as a graph execution producing NaNs occurs, snapshots will be automatically produced and execution will be terminated. Occasionally, for larger models, automatic snapshotting may not capture snapshots due to the device memory being exhausted. In this case, the above flag can be set to <code class="docutils literal notranslate"><span class="pre">os.environ["NEURON_DUMP_HLO_SNAPSHOT"]</span> <span class="pre">=</span> <span class="pre">"ON_NRT_ERROR_HYBRID"</span></code>, this will allocate memory for inputs on both the device and host memory. In some additional cases, this may still go out of memory and may need to be set to <code class="docutils literal notranslate"><span class="pre">os.environ["NEURON_DUMP_HLO_SNAPSHOT"]</span> <span class="pre">=</span> <span class="pre">"ON_NRT_ERROR_CPU"</span></code> to avoid allocating any memory on the device at all for automatic snapshotting.</p> <div class="section" id="snapshot-faqs"> <h3><a class="toc-backref" href="#id7"><strong>Snapshot FAQs:</strong></a><a class="headerlink" href="#snapshot-faqs" title="Permalink to this headline">#</a></h3> <p><strong>When should I use this features?</strong></p> <p>This feature should be used when debugging errors that requires interfacing with and providing debug data to the Neuron team. Snapshotting may be redundant and unnecessary in some situations. For example, when only the model weights are necessary for debugging, methods such as checkpointing may be more convenient to use.</p> <p><strong>What sort of data is captured with these snapshots?</strong></p> <p>The type of data captured by these snapshots may include model graphs in HLO form, weights/parameters, optimizer states, intermediate tensors and gradients. This data may be considered sensitive and this should be taken into account before sending the data to the Neuron team.</p> <p><strong>What is the size of these snapshots?</strong></p> <p>The size of snapshots can be significant for larger models such as GPT or BERT with several GBs worth of data for larger graphs, so it is recommended to check that sufficient disk space exists before using snapshotting. In addition, limiting the amount of snapshots taken in a run will help to preserve disk space.</p> <p><strong>Will snapshotting add overhead to my execution?</strong></p> <p>Snapshotting does add a small overhead to the execution in most cases. This overhead can be significant if snapshots are dumped at every iteration. In order to alleviate some of this overhead, in the case that snapshotting is not necessary on all cores the following environment variable can be set to collect snapshots only on the first core. In addition, checkpointing in tandem with snapshotting can be useful to reduce overhead. A checkpoint close to the problem iteration can be captured, then execution resumed with snapshots enabled.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="o">....</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_NC0_ONLY_SNAPSHOT"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span> <span class="o">....</span> </pre></div> </div> <p><strong>How can I share snapshots with the Neuron team?</strong></p> <p>These snapshots can be shared with the Neuron team via S3 bucket.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="pytorch-neuron-programming-guide.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Developer Guide for Training with PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../torch-neuronx-profiling-dev-guide.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Developer Guide for Profiling with PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:09.300Z
Developer Guide (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/training/index.html
# Developer Guide (torch-neuronx) — AWS Neuron Documentation previous PyTorch Neuron (`torch-neuronx`) Profiling API
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Developer Guide (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="Developer Guide for Training with PyTorch Neuron (torch-neuronx)" href="pytorch-neuron-programming-guide.html"> <link rel="prev" title="PyTorch Neuron (torch-neuronx) Profiling API" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/programming-guide/training/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/programming-guide/training/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/training/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/programming-guide/training/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Developer Guide (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="developer-guide-torch-neuronx"> <h1>Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#developer-guide-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in" open="open"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-small"> Developer Guide<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="pytorch-neuron-programming-guide.html#pytorch-neuronx-programming-guide"><span class="std std-ref">Developer Guide for Training with PyTorch Neuron (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="pytorch-neuron-debug.html#pytorch-neuronx-debug"><span class="std std-ref">How to debug models in PyTorch Neuron (torch-neuronx)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../torch-neuronx-profiling-dev-guide.html#torch-neuronx-dev-guide"><span class="std std-ref">Developer Guide for Profiling with PyTorch Neuron (torch-neuronx)</span></a></p></li> </ul> </div> </details><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../api-reference-guide/torch-neuronx-profiling-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Profiling API</p> </div> </a> <a class="right-next" id="next-link" href="pytorch-neuron-programming-guide.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Developer Guide for Training with PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:09.803Z
Neuron Persistent Cache — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/general/arch/neuron-features/neuron-caching.html
# Neuron Persistent Cache — AWS Neuron Documentation ## Neuron Persistent Cache[#](#neuron-persistent-cache "Permalink to this headline") PyTorch Neuron (`torch-neuronx`) uses `torch-xla`, and `torch-xla` operates in lazy mode. In other words, every operation in training script is recorded in a graph. The graph is executed only when the results are requested by the user when they use `print` or `xm.mark_step`. Requesting results tells `torch-xla` that the recorded graph needs to be executed. Before executing the graph on a Neuron device, `torch-xla` would call Neuron Compiler (`neuronx-cc`) to compile the graph into Neuron specific graph. Then the graph is executed on the [NeuronCore/s](../neuron-hardware/neuroncores-arch.html#neuroncores-arch). Compiling the graph involves running optimizations that can make use of the [NeuronCore/s](../neuron-hardware/neuroncores-arch.html#neuroncores-arch) efficiently. Running these optimizations can be expensive and can result in long compile times. To save the users from compiling these graphs at every iteration, `torch-xla` maintains an in-memory cache called Just in Time (JIT) cache. When the user re-runs the same graph (eg. 2nd iteration of the training run), torch-xla would check in this JIT cache and re-use the cached compilation result, thereby avoiding the wait times. Since the JIT cache is an in-memory cache, it needs to be constructed every time the training script is run. Hence, if the user re-runs the training script, a new JIT cache is created. This causes a compilation for the first training graph. To avoid such compilations across training runs, PyTorch Neuron (`torch-neuronx`) has built an on-disk `Neuron Persistent Cache`. Since this cache is on-disk, its persistent across training runs. So now, when a graph is compiled for the fist time, the compilation result is saved in `Neuron Persistent Cache`. When the user re-runs the training script, since the JIT cache is not ready, it would send the graph for compilation. PyTorch Neuron (`torch-neuronx`) would then check if the compiled result is present in the `Neuron Persistent Cache`, if yes, it would return with the compiled result. This on-disk cache thereby avoids compilations across training runs. This cache is enabled by default for Neuron’s PyTorch/XLA flow (training) as well as transformers-neuronx LLM inference package. The default cache path is the directory `/var/tmp/neuron-compile-cache`. Look at the diagram below on the end to end flow: ![Image:](../../../_images/NeuronCaching.png) As seen from the diagram, the operations are recorded in a graph in lazy mode and only when a mark\_step is hit, the graph is executed. Before execution, the graph passes through two caches to check if we have compiled the graph sometime in the past. If yes, we reuse the compilation result and execute with it. This avoid duplicate compilations. One thing to note, both JIT cache and Neuron Cache are complementary to each other. JIT cache prevents duplicate compilation within a run and Neuron Cache prevents duplicate compilations across training runs. For example, within a training script, we have a training loop that iterates through the dataset. The first iteration would trace a unique graph and the following iteration would trace a graph that is similar to the first one. In this case, the subsequent iterations would hit the JIT cache and reuse the result. However, to save users from compiling for the first iteration graph, `Neuron Persistent Cache` would be used. In this case, the very first time when the script is run, the `Neuron Persistent Cache` would be updated. Going forward when we re-run the training script, compilation results from `Neuron Persistent Cache` would be used. To better understand how `Neuron Persistent Cache` works, consider the example below: ``` import torch import torch_xla import torch_xla.core.xla_model as xm device = xm.xla_device() t1 = torch.randn(3, 3).to(device) t2 = t1 / 0.5 x = t2.cpu() ``` Running the above example produces the following logs: ``` 2023-08-25 21:51:36.000433: INFO ||NCC_WRAPPER||: Compile cache path: /var/tmp/neuron-compile-cache . Compiler status PASS ``` Re-running the above script would fetch the graph from the neuron cache and you would see logs as follows: ``` 2023-08-25 21:52:23.000451: INFO ||NCC_WRAPPER||: Compile cache path: /var/tmp/neuron-compile-cache 2023-08-25 21:52:23.000453: INFO ||NCC_WRAPPER||: Using a cached neff at /var/tmp/neuron-compile-cache/neuronxcc-2.8.0.25+a3ad0f342/MODULE_198775565831884870+d41d8cd9/model.neff. Exiting with a successfully compiled graph. ``` As you can see, the next run picks the compiled graph from cache, thereby saving the compilation time. The cache uses hash of the Neuron compiler flags and XLA graph as the key. If the Neuron compiler version or XLA graph changes, you will see recompilation. Examples of changes that would cause XLA graph change include: - Model type and size - Batch size - Optimizer and optimizer hyperparameters - Location of xm.mark\_step() To keep cache size small and to enable weights/parameters updates without recompilation, only the compute graphs are cached when using transformers-neuronx (weights/parameters are inputs to the compute graphs) and training flow using torch-neuronx’s XLA (weights/parameters are inputs and outputs of the compute graphs). Note that this caching mechanism doesn’t apply to the torch-neuronx trace API where the weights/parameters are frozen and converted to constants, then compiled together with the compute operations (traced graphs with frozen weights/parameters are not cached). All compilation results are saved in the cache. To disable the cache, you can pass `--no_cache` option via NEURON\_CC\_FLAGS: ``` os.environ['NEURON_CC_FLAGS'] = os.environ.get('NEURON_CC_FLAGS', '') + ' --no_cache' ``` The default cache path is the directory `/var/tmp/neuron-compile-cache`. To change the cache’s location, pass `cache_dir=<cache_url>` option via `NEURON_CC_FLAGS` or `NEURON_COMPILE_CACHE_URL=<cache_url>` environment variables: ``` os.environ['NEURON_CC_FLAGS'] = os.environ.get('NEURON_CC_FLAGS', '') + ' --cache_dir=<cache URL>' ``` ``` os.environ['NEURON_COMPILE_CACHE_URL'] = '<cache_URL>' ``` The cache URL specified using `--cache_dir` is prioritized over that specified using `NEURON_COMPILE_CACHE_URL` if both are set. If `<cache_url>` starts with `s3://`, it will use the AWS S3 URL as the cache location, provided that the corresponding S3 bucket exists and is both readable and writeable. You can change the verbose level of the compiler by adding `log_level` to either `WARNING`, `INFO` or `ERROR`. This can be done as follows: ``` os.environ['NEURON_CC_FLAGS'] = os.environ.get('NEURON_CC_FLAGS', '') + ' --log_level=INFO' ``` A graph compilation can fail because of a compilation error or an environment issue (for example, compilation is interrupted by ctrl-C). The graph would be marked as failed and subsequent rerun would encounter message like below: ``` INFO ||NCC_WRAPPER||: Got a cached failed neff at /var/tmp/neuron-compile-cache/neuronxcc-2.8.0.25+a3ad0f342/MODULE_12486829708343293975+d41d8cd9/model.neff. Will skip compilation, please set --retry_failed_compilation for recompilation. ``` To retry compilation, add `--retry_failed_compilation` in `NEURON_CC_FLAGS` environment variable. When the script is reran, all the previously failed compilations are recompiled and fresh results are saved in the cache. ``` os.environ['NEURON_CC_FLAGS'] = os.environ.get('NEURON_CC_FLAGS', '') + ' --retry_failed_compilation' ``` Note that all flags demonstrated above will be parsed by a tool called `neuron_cc_wrapper`, which is a wrapper over Neuron Compiler CLI to provide caching mechanism. All these flags will not be passed into Neuron Compiler CLI. _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Neuron Persistent Cache — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuronx) Profiling API" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> <link rel="prev" title="PyTorch Neuron Environment Variables (torch-neuronx)" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "general/arch/neuron-features/neuron-caching", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> Features </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2 current active"> <a class="current reference internal" href="#"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fgeneral/arch/neuron-features/neuron-caching.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/general/arch/neuron-features/neuron-caching.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/general/arch/neuron-features/neuron-caching.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Neuron Persistent Cache</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="neuron-persistent-cache"> <span id="neuron-caching"></span><h1>Neuron Persistent Cache<a class="headerlink" href="#neuron-persistent-cache" title="Permalink to this headline">#</a></h1> <p>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) uses <code class="docutils literal notranslate"><span class="pre">torch-xla</span></code>, and <code class="docutils literal notranslate"><span class="pre">torch-xla</span></code> operates in lazy mode. In other words, every operation in training script is recorded in a graph. The graph is executed only when the results are requested by the user when they use <code class="docutils literal notranslate"><span class="pre">print</span></code> or <code class="docutils literal notranslate"><span class="pre">xm.mark_step</span></code>. Requesting results tells <code class="docutils literal notranslate"><span class="pre">torch-xla</span></code> that the recorded graph needs to be executed.</p> <p>Before executing the graph on a Neuron device, <code class="docutils literal notranslate"><span class="pre">torch-xla</span></code> would call Neuron Compiler (<code class="docutils literal notranslate"><span class="pre">neuronx-cc</span></code>) to compile the graph into Neuron specific graph. Then the graph is executed on the <a class="reference internal" href="../neuron-hardware/neuroncores-arch.html#neuroncores-arch"><span class="std std-ref">NeuronCore/s</span></a>. Compiling the graph involves running optimizations that can make use of the <a class="reference internal" href="../neuron-hardware/neuroncores-arch.html#neuroncores-arch"><span class="std std-ref">NeuronCore/s</span></a> efficiently. Running these optimizations can be expensive and can result in long compile times. To save the users from compiling these graphs at every iteration, <code class="docutils literal notranslate"><span class="pre">torch-xla</span></code> maintains an in-memory cache called Just in Time (JIT) cache. When the user re-runs the same graph (eg. 2nd iteration of the training run), torch-xla would check in this JIT cache and re-use the cached compilation result, thereby avoiding the wait times.</p> <p>Since the JIT cache is an in-memory cache, it needs to be constructed every time the training script is run. Hence, if the user re-runs the training script, a new JIT cache is created. This causes a compilation for the first training graph. To avoid such compilations across training runs, PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) has built an on-disk <code class="docutils literal notranslate"><span class="pre">Neuron</span> <span class="pre">Persistent</span> <span class="pre">Cache</span></code>. Since this cache is on-disk, its persistent across training runs. So now, when a graph is compiled for the fist time, the compilation result is saved in <code class="docutils literal notranslate"><span class="pre">Neuron</span> <span class="pre">Persistent</span> <span class="pre">Cache</span></code>. When the user re-runs the training script, since the JIT cache is not ready, it would send the graph for compilation. PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) would then check if the compiled result is present in the <code class="docutils literal notranslate"><span class="pre">Neuron</span> <span class="pre">Persistent</span> <span class="pre">Cache</span></code>, if yes, it would return with the compiled result. This on-disk cache thereby avoids compilations across training runs. This cache is enabled by default for Neuron’s PyTorch/XLA flow (training) as well as transformers-neuronx LLM inference package. The default cache path is the directory <code class="docutils literal notranslate"><span class="pre">/var/tmp/neuron-compile-cache</span></code>.</p> <p>Look at the diagram below on the end to end flow:</p> <p><img alt="Image:" src="../../../_images/NeuronCaching.png"></p> <p>As seen from the diagram, the operations are recorded in a graph in lazy mode and only when a mark_step is hit, the graph is executed. Before execution, the graph passes through two caches to check if we have compiled the graph sometime in the past. If yes, we reuse the compilation result and execute with it. This avoid duplicate compilations. One thing to note, both JIT cache and Neuron Cache are complementary to each other. JIT cache prevents duplicate compilation within a run and Neuron Cache prevents duplicate compilations across training runs. For example, within a training script, we have a training loop that iterates through the dataset. The first iteration would trace a unique graph and the following iteration would trace a graph that is similar to the first one. In this case, the subsequent iterations would hit the JIT cache and reuse the result. However, to save users from compiling for the first iteration graph, <code class="docutils literal notranslate"><span class="pre">Neuron</span> <span class="pre">Persistent</span> <span class="pre">Cache</span></code> would be used. In this case, the very first time when the script is run, the <code class="docutils literal notranslate"><span class="pre">Neuron</span> <span class="pre">Persistent</span> <span class="pre">Cache</span></code> would be updated. Going forward when we re-run the training script, compilation results from <code class="docutils literal notranslate"><span class="pre">Neuron</span> <span class="pre">Persistent</span> <span class="pre">Cache</span></code> would be used.</p> <p>To better understand how <code class="docutils literal notranslate"><span class="pre">Neuron</span> <span class="pre">Persistent</span> <span class="pre">Cache</span></code> works, consider the example below:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch_xla</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="n">t1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">t2</span> <span class="o">=</span> <span class="n">t1</span> <span class="o">/</span> <span class="mf">0.5</span> <span class="n">x</span> <span class="o">=</span> <span class="n">t2</span><span class="o">.</span><span class="n">cpu</span><span class="p">()</span> </pre></div> </div> <p>Running the above example produces the following logs:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">2023</span>-08-25<span class="w"> </span><span class="m">21</span>:51:36.000433:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Compile<span class="w"> </span>cache<span class="w"> </span>path:<span class="w"> </span>/var/tmp/neuron-compile-cache . Compiler<span class="w"> </span>status<span class="w"> </span>PASS </pre></div> </div> <p>Re-running the above script would fetch the graph from the neuron cache and you would see logs as follows:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">2023</span>-08-25<span class="w"> </span><span class="m">21</span>:52:23.000451:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Compile<span class="w"> </span>cache<span class="w"> </span>path:<span class="w"> </span>/var/tmp/neuron-compile-cache <span class="m">2023</span>-08-25<span class="w"> </span><span class="m">21</span>:52:23.000453:<span class="w"> </span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Using<span class="w"> </span>a<span class="w"> </span>cached<span class="w"> </span>neff<span class="w"> </span>at<span class="w"> </span>/var/tmp/neuron-compile-cache/neuronxcc-2.8.0.25+a3ad0f342/MODULE_198775565831884870+d41d8cd9/model.neff.<span class="w"> </span>Exiting<span class="w"> </span>with<span class="w"> </span>a<span class="w"> </span>successfully<span class="w"> </span>compiled<span class="w"> </span>graph. </pre></div> </div> <p>As you can see, the next run picks the compiled graph from cache, thereby saving the compilation time. The cache uses hash of the Neuron compiler flags and XLA graph as the key. If the Neuron compiler version or XLA graph changes, you will see recompilation. Examples of changes that would cause XLA graph change include:</p> <ul class="simple"> <li><p>Model type and size</p></li> <li><p>Batch size</p></li> <li><p>Optimizer and optimizer hyperparameters</p></li> <li><p>Location of xm.mark_step()</p></li> </ul> <p>To keep cache size small and to enable weights/parameters updates without recompilation, only the compute graphs are cached when using transformers-neuronx (weights/parameters are inputs to the compute graphs) and training flow using torch-neuronx’s XLA (weights/parameters are inputs and outputs of the compute graphs). Note that this caching mechanism doesn’t apply to the torch-neuronx trace API where the weights/parameters are frozen and converted to constants, then compiled together with the compute operations (traced graphs with frozen weights/parameters are not cached).</p> <p>All compilation results are saved in the cache. To disable the cache, you can pass <code class="docutils literal notranslate"><span class="pre">--no_cache</span></code> option via NEURON_CC_FLAGS:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span> <span class="s1">' --no_cache'</span> </pre></div> </div> <p>The default cache path is the directory <code class="docutils literal notranslate"><span class="pre">/var/tmp/neuron-compile-cache</span></code>. To change the cache’s location, pass <code class="docutils literal notranslate"><span class="pre">cache_dir=&lt;cache_url&gt;</span></code> option via <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code> or <code class="docutils literal notranslate"><span class="pre">NEURON_COMPILE_CACHE_URL=&lt;cache_url&gt;</span></code> environment variables:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span> <span class="s1">' --cache_dir=&lt;cache URL&gt;'</span> </pre></div> </div> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_COMPILE_CACHE_URL'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'&lt;cache_URL&gt;'</span> </pre></div> </div> <p>The cache URL specified using <code class="docutils literal notranslate"><span class="pre">--cache_dir</span></code> is prioritized over that specified using <code class="docutils literal notranslate"><span class="pre">NEURON_COMPILE_CACHE_URL</span></code> if both are set. If <code class="docutils literal notranslate"><span class="pre">&lt;cache_url&gt;</span></code> starts with <code class="docutils literal notranslate"><span class="pre">s3://</span></code>, it will use the AWS S3 URL as the cache location, provided that the corresponding S3 bucket exists and is both readable and writeable.</p> <p>You can change the verbose level of the compiler by adding <code class="docutils literal notranslate"><span class="pre">log_level</span></code> to either <code class="docutils literal notranslate"><span class="pre">WARNING</span></code>, <code class="docutils literal notranslate"><span class="pre">INFO</span></code> or <code class="docutils literal notranslate"><span class="pre">ERROR</span></code>. This can be done as follows:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span> <span class="s1">' --log_level=INFO'</span> </pre></div> </div> <p>A graph compilation can fail because of a compilation error or an environment issue (for example, compilation is interrupted by ctrl-C). The graph would be marked as failed and subsequent rerun would encounter message like below:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>INFO<span class="w"> </span><span class="o">||</span>NCC_WRAPPER<span class="o">||</span>:<span class="w"> </span>Got<span class="w"> </span>a<span class="w"> </span>cached<span class="w"> </span>failed<span class="w"> </span>neff<span class="w"> </span>at<span class="w"> </span>/var/tmp/neuron-compile-cache/neuronxcc-2.8.0.25+a3ad0f342/MODULE_12486829708343293975+d41d8cd9/model.neff.<span class="w"> </span>Will<span class="w"> </span>skip<span class="w"> </span>compilation,<span class="w"> </span>please<span class="w"> </span><span class="nb">set</span><span class="w"> </span>--retry_failed_compilation<span class="w"> </span><span class="k">for</span><span class="w"> </span>recompilation. </pre></div> </div> <p>To retry compilation, add <code class="docutils literal notranslate"><span class="pre">--retry_failed_compilation</span></code> in <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code> environment variable. When the script is reran, all the previously failed compilations are recompiled and fresh results are saved in the cache.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span> <span class="s1">' --retry_failed_compilation'</span> </pre></div> </div> <p>Note that all flags demonstrated above will be parsed by a tool called <code class="docutils literal notranslate"><span class="pre">neuron_cc_wrapper</span></code>, which is a wrapper over Neuron Compiler CLI to provide caching mechanism. All these flags will not be passed into Neuron Compiler CLI.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron Environment Variables (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Profiling API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:10.063Z
PyTorch Neuron (torch-neuronx) Profiling API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html
# PyTorch Neuron (torch-neuronx) Profiling API — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## PyTorch Neuron (`torch-neuronx`) Profiling API[#](#pytorch-neuron-torch-neuronx-profiling-api "Permalink to this headline") The profiler provides a method to generate a context manager to capture trace events at the operator or runtime level. torch\_neuronx.experimental.profiler.profile(_port\=9012_, _ms\_duration\=60000_, _neuron\_tensorboard\_plugin\_dir\='logs/plugins/neuron'_, _profile\_type\='operator'_, _auto\_start\=True_, _delete\_working\=True_)[#](#torch_neuronx.experimental.profiler.profile "Permalink to this definition") The [`torch_neuronx.experimental.profiler.profile()`](#torch_neuronx.experimental.profiler.profile "torch_neuronx.experimental.profiler.profile") method retuns a `profile` context manager object. This object doesn’t need to be used directly, as default options are set to auto capture events based on the `profile_type`. The context manager will wrap around the entire model and training/inference loop. The context-manager is backwards-compatible with the torch\_xla.debug.profiler\`\` _Required Arguments_ None _Optional Keyword Arguments_ Keyword Arguments - **port** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – Port to run the profiling GRPC server on. Default is 9012. - **ms\_duration** ([_int_](https://docs.python.org/3/library/functions.html#int "(in Python v3.11)")) – This defines how long the profiler will capture the HLO artifacts from the model to view in the profiler. The unit is in milliseconds. The default value is 60000 ms, or 1 minute. - **neuron\_tensorboard\_plugin\_dir** ([_str_](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.11)")) – The directory the neuron tensorboard plugin will file write to. This will be `logs/plugins/neuron` by default/ - **profile\_type** ([_str_](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.11)")) – There is “trace” and “operator”. “trace” is the Torch Runtime Trace Level, while “operator” is the Model Operator Trace Level. Default is “operator” - **auto\_start** ([_bool_](https://docs.python.org/3/library/functions.html#bool "(in Python v3.11)")) – If set to true, the profiler will start profiling immediately. If set to false, the profiler can be set to start at a later condition. Refer to `profile.start()` for more details. Default is `True`. - **delete\_working** ([_bool_](https://docs.python.org/3/library/functions.html#bool "(in Python v3.11)")) – If set to False turns off the deletion of temporary files. Default True. - **traced\_only** ([_str_](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.11)")) – This should be set to `True` if profiling a model that has been traced with `torch_neuronx.trace()`. Default is `False`. Returns The traced [`profile`](#torch_neuronx.experimental.profiler.profile "torch_neuronx.experimental.profiler.profile") Return type ~profile torch\_neuronx.experimental.profiler.profile.start()[#](#torch_neuronx.experimental.profiler.profile.start "Permalink to this definition") The [`torch_neuronx.experimental.profiler.profile.start()`](#torch_neuronx.experimental.profiler.profile.start "torch_neuronx.experimental.profiler.profile.start") method starts the profiler if not started (i.e when `auto_start=False`). This function does not take in any parameters, nor return anything. > _Required Arguments_ None > _Optional Keyword Arguments_ None Returns None _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuronx) Profiling API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Developer Guide (torch-neuronx)" href="../programming-guide/training/index.html"> <link rel="prev" title="Neuron Persistent Cache" href="../../../../general/arch/neuron-features/neuron-caching.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="training/index.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuronx) Profiling API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-torch-neuronx-profiling-api"> <span id="torch-neuronx-profiling-api"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) Profiling API<a class="headerlink" href="#pytorch-neuron-torch-neuronx-profiling-api" title="Permalink to this headline">#</a></h1> <p>The profiler provides a method to generate a context manager to capture trace events at the operator or runtime level.</p> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.experimental.profiler.profile"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.experimental.profiler.</span></span><span class="sig-name descname"><span class="pre">profile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">9012</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ms_duration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">60000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">neuron_tensorboard_plugin_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'logs/plugins/neuron'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">profile_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'operator'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delete_working</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.experimental.profiler.profile" title="Permalink to this definition">#</a></dt> <dd><p>The <a class="reference internal" href="#torch_neuronx.experimental.profiler.profile" title="torch_neuronx.experimental.profiler.profile"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.experimental.profiler.profile()</span></code></a> method retuns a <code class="docutils literal notranslate"><span class="pre">profile</span></code> context manager object. This object doesn’t need to be used directly, as default options are set to auto capture events based on the <code class="docutils literal notranslate"><span class="pre">profile_type</span></code>.</p> <p>The context manager will wrap around the entire model and training/inference loop. The context-manager is backwards-compatible with the torch_xla.debug.profiler``</p> <p><em>Required Arguments</em></p> <p>None</p> <p><em>Optional Keyword Arguments</em></p> <dl class="field-list simple"> <dt class="field-odd">Keyword Arguments</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>port</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Port to run the profiling GRPC server on. Default is 9012.</p></li> <li><p><strong>ms_duration</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – This defines how long the profiler will capture the HLO artifacts from the model to view in the profiler. The unit is in milliseconds. The default value is 60000 ms, or 1 minute.</p></li> <li><p><strong>neuron_tensorboard_plugin_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – The directory the neuron tensorboard plugin will file write to. This will be <code class="docutils literal notranslate"><span class="pre">logs/plugins/neuron</span></code> by default/</p></li> <li><p><strong>profile_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – There is “trace” and “operator”. “trace” is the Torch Runtime Trace Level, while “operator” is the Model Operator Trace Level. Default is “operator”</p></li> <li><p><strong>auto_start</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – If set to true, the profiler will start profiling immediately. If set to false, the profiler can be set to start at a later condition. Refer to <code class="docutils literal notranslate"><span class="pre">profile.start()</span></code> for more details. Default is <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p></li> <li><p><strong>delete_working</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – If set to False turns off the deletion of temporary files. Default True.</p></li> <li><p><strong>traced_only</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – This should be set to <code class="docutils literal notranslate"><span class="pre">True</span></code> if profiling a model that has been traced with <code class="docutils literal notranslate"><span class="pre">torch_neuronx.trace()</span></code>. Default is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li> </ul> </dd> <dt class="field-even">Returns</dt> <dd class="field-even"><p>The traced <a class="reference internal" href="#torch_neuronx.experimental.profiler.profile" title="torch_neuronx.experimental.profiler.profile"><code class="xref py py-class docutils literal notranslate"><span class="pre">profile</span></code></a></p> </dd> <dt class="field-odd">Return type</dt> <dd class="field-odd"><p>~profile</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="torch_neuronx.experimental.profiler.profile.start"> <span class="sig-prename descclassname"><span class="pre">torch_neuronx.experimental.profiler.profile.</span></span><span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#torch_neuronx.experimental.profiler.profile.start" title="Permalink to this definition">#</a></dt> <dd><p>The <a class="reference internal" href="#torch_neuronx.experimental.profiler.profile.start" title="torch_neuronx.experimental.profiler.profile.start"><code class="xref py py-func docutils literal notranslate"><span class="pre">torch_neuronx.experimental.profiler.profile.start()</span></code></a> method starts the profiler if not started (i.e when <code class="docutils literal notranslate"><span class="pre">auto_start=False</span></code>). This function does not take in any parameters, nor return anything.</p> <blockquote> <div><p><em>Required Arguments</em></p> </div></blockquote> <p>None</p> <blockquote> <div><p><em>Optional Keyword Arguments</em></p> </div></blockquote> <p>None</p> <dl class="field-list simple"> <dt class="field-odd">Returns</dt> <dd class="field-odd"><p>None</p> </dd> </dl> </dd></dl> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../general/arch/neuron-features/neuron-caching.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Neuron Persistent Cache</p> </div> </a> <a class="right-next" id="next-link" href="../programming-guide/training/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:10.213Z
Developer Guide for Training with PyTorch Neuron (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html
# Developer Guide for Training with PyTorch Neuron (torch-neuronx) — AWS Neuron Documentation _This document is relevant for_: `Trn1`, `Trn1n` ## Developer Guide for Training with PyTorch Neuron (`torch-neuronx`)[#](#developer-guide-for-training-with-pytorch-neuron-torch-neuronx "Permalink to this headline") Table of Contents - [PyTorch Neuron](#pytorch-neuron) - [Neuron XLA device](#neuron-xla-device) - [PyTorch Neuron single-worker training/evaluation quick-start](#pytorch-neuron-single-worker-training-evaluation-quick-start) - [PyTorch Neuron multi-worker data parallel training using torchrun](#pytorch-neuron-multi-worker-data-parallel-training-using-torchrun) - [Conversion from Distributed Data Parallel (DDP) application](#conversion-from-distributed-data-parallel-ddp-application) - [PyTorch Neuron environment variables](#pytorch-neuron-environment-variables) - [Neuron Persistent Cache for compiled graphs](#neuron-persistent-cache-for-compiled-graphs) - [Number of graphs](#number-of-graphs) - [Automatic casting of float tensors to BFloat16](#automatic-casting-of-float-tensors-to-bfloat16) - [Automatic Mixed-Precision](#automatic-mixed-precision) - [BF16 mixed-precision using PyTorch Autocast](#bf16-mixed-precision-using-pytorch-autocast) - [Tips and Best Practices](#tips-and-best-practices) - [Understand the lazy mode in PyTorch Neuron](#understand-the-lazy-mode-in-pytorch-neuron) - [Minimize the number of compilation-and-executions](#minimize-the-number-of-compilation-and-executions) - [Ensure common initial weights across workers](#ensure-common-initial-weights-across-workers) - [Use PyTorch/XLA’s model save function](#use-pytorch-xla-s-model-save-function) - [FAQ](#faq) - [What is the difference between Trainium and Inferentia?](#what-is-the-difference-between-trainium-and-inferentia) - [Debugging and troubleshooting](#debugging-and-troubleshooting) Trainium is designed to speed up model training and reduce training cost. It is available on the Trn1 instances. Each Trainium accelerator has two NeuronCores, which are the main neural network compute units. PyTorch Neuron enables PyTorch users to train their models on Trainium’s NeuronCores with little code change to their training code. It is based on the [PyTorch/XLA software package](https://pytorch.org/xla). This guide helps you get started with single-worker training and distributed training using PyTorch Neuron. ## [PyTorch Neuron](#id2)[#](#pytorch-neuron "Permalink to this headline") ### [Neuron XLA device](#id3)[#](#neuron-xla-device "Permalink to this headline") With PyTorch Neuron the default XLA device is mapped to a NeuronCore. By default, one NeuronCore is configured. To use Neuron XLA device, specify the device as `xm.xla_device()` or `'xla'`: ``` import torch_xla.core.xla_model as xm device = xm.xla_device() ``` or PyTorch models and tensors can be mapped to the device as usual: ``` model.to(device) tensor.to(device) ``` To move tensor back to CPU, do : or ## [PyTorch Neuron single-worker training/evaluation quick-start](#id4)[#](#pytorch-neuron-single-worker-training-evaluation-quick-start "Permalink to this headline") PyTorch Neuron uses XLA to enable conversion of PyTorch operations to Trainium instructions. To get started on PyTorch Neuron, first modify your [training script](../../tutorials/training/mlp.html#neuronx-mlp-training-tutorial) to use XLA in the same manner as described in [PyTorch/XLA documentation](https://pytorch.org/xla) and use XLA device: ``` import torch_xla.core.xla_model as xm device = xm.xla_device() # or device = 'xla' ``` The NeuronCore is mapped to an XLA device. On Trainium instance, the XLA device is automatically mapped to the first available NeuronCore. By default the above steps will enable the training or evaluation script to run on one NeuronCore. NOTE: Each process is mapped to one NeuronCore. Finally, add `mark_step` at the end of the training or evaluation step to compile and execute the training or evaluation step: These changes can be placed in control-flows in order to keep the script the same between PyTorch Neuron and CPU/GPU. For example, you can use an environment variable to disable XLA which would cause the script to run in PyTorch native mode (using CPU on Trainium instances and GPU on GPU instances): ``` device = 'cpu' if not os.environ.get("DISABLE_XLA", None): device = 'xla' ... # end of training step if not os.environ.get("DISABLE_XLA", None): xm.mark_step() ``` More on the need for mark\_step is at [Understand the lazy mode in PyTorch Neuron](#understand-the-lazy-mode-in-pytorch-neuron). For a full runnable example, please see the Single-worker MLP training on Trainium tutorial. ## [PyTorch Neuron multi-worker data parallel training using torchrun](#id5)[#](#pytorch-neuron-multi-worker-data-parallel-training-using-torchrun "Permalink to this headline") Data parallel training allows you to replicate your script across multiple workers, each worker processing a proportional portion of the dataset, in order to train faster. To run multiple workers in data parallel configuration, with each worker using one NeuronCore, first add additional imports for parallel dataloader and multi-processing utilities: ``` import torch_xla.distributed.parallel_loader as pl ``` Next we initialize the Neuron distributed context using the XLA backend for torch.distributed: ``` import torch_xla.distributed.xla_backend torch.distributed.init_process_group('xla') ``` Next, replace `optimizer.step()` function call with `xm.optimizer_step(optimizer)` which adds gradient synchronization across workers before taking the optimizer step: ``` xm.optimizer_step(optimizer) ``` If you’re using a distributed dataloader, wrap your dataloader in the PyTorch/XLA’s `MpDeviceLoader` class which provides buffering to hide CPU to device data load latency: ``` parallel_loader = pl.MpDeviceLoader(dataloader, device) ``` Within the training code, use xm.xrt\_world\_size() to get the world size, and xm.get\_ordinal to get the global rank of the current process. Then run use [PyTorch torchrun](https://pytorch.org/docs/stable/elastic/run.html#launcher-api) utility to run the script. For example, to run 32 worker data parallel training: `torchrun --nproc_per_node=32 <script and options>` To run on multiple instances, make sure to use trn1.32xlarge instances and use all 32 NeuronCores on each instance. For example, with two instances, on the rank-0 Trn1 host, run with –node\_rank=0 using torchrun utility: ``` torchrun --nproc_per_node=32 --nnodes=2 --node_rank=0 --master_addr=<root IP> --master_port=<root port> <script and options> ``` On another Trn1 host, run with –node\_rank=1 : ``` torchrun --nproc_per_node=32 --nnodes=2 --node_rank=1 --master_addr=<root IP> --master_port=<root port> <script and options> ``` It is important to launch rank-0 worker with –node\_rank=0 to avoid hang. More information about torchrun can be found PyTorch documentation at [https://pytorch.org/docs/stable/elastic/run.html#launcher-api](https://pytorch.org/docs/stable/elastic/run.html#launcher-api) . See the Multi-worker data-parallel MLP training using torchrun tutorial for a full example. ## [Conversion from Distributed Data Parallel (DDP) application](#id6)[#](#conversion-from-distributed-data-parallel-ddp-application "Permalink to this headline") Distributed Data Parallel (DDP) in torch.distributed module is a wrapper to help convert a single-worker training to distributed training. To convert from torch.distributed Distributed Data Parallel (DDP) application to PyTorch Neuron, first convert the application back to single-worker training, which simply involves removing the DDP wrapper, for example `model = DDP(model, device_ids=[rank])`. After this, follow the previous section to change to multi-worker training. ## [Number of graphs](#id9)[#](#number-of-graphs "Permalink to this headline") PyTorch/XLA converts PyTorch’s eager mode execution to lazy-mode graph-based execution. During this process, there can be multiple graphs compiled and executed if there are extra mark-steps or functions with implicit mark-steps. Additionally, more graphs can be generated if there are different execution paths taken due to control-flows. ## [Automatic casting of float tensors to BFloat16](#id10)[#](#automatic-casting-of-float-tensors-to-bfloat16 "Permalink to this headline") With PyTorch Neuron, the default behavior is for torch.float (FP32) and torch.double (FP64) tensors to be mapped to torch.float in hardware. To reduce memory footprint and improve performance, torch.float and torch.double tensors can automatically be converted to BFloat16 by setting the environment variable `XLA_USE_BF16=1`. Alternatively, torch.float can automatically be converted to BFloat16 and torch.double converted to FP32 by setting the environment variable `XLA_DOWNCAST_BF16=1`. ## [Automatic Mixed-Precision](#id11)[#](#automatic-mixed-precision "Permalink to this headline") ### [BF16 mixed-precision using PyTorch Autocast](#id12)[#](#bf16-mixed-precision-using-pytorch-autocast "Permalink to this headline") By default, the compiler automatically cast internal FP32 operations to BF16. You can disable this and allow PyTorch’s BF16 mixed-precision to do the casting. PyTorch’s BF16 mixed-precision is achieved by casting certain operations to operate BF16. We currently use CUDA’s list of operations that can operate in BF16: (NOTE: Although convolution is in the list below, it is currently unsupported by Neuron. See model-architecture-fit) ``` _convolution _convolution _convolution_nogroup conv1d conv2d conv3d conv_tbc conv_transpose1d conv_transpose2d conv_transpose3d convolution cudnn_convolution cudnn_convolution_transpose cudnn_convolution cudnn_convolution_transpose cudnn_convolution cudnn_convolution_transpose prelu addmm addmv addr matmul mm mv linear addbmm baddbmm bmm chain_matmul linalg_multi_dot ``` To enable PyTorch’s BF16 mixed-precision, first turn off the Neuron compiler auto-cast: ``` os.environ["NEURON_CC_FLAGS"] = "--auto-cast=none" ``` Next, overwrite torch.cuda.is\_bf16\_supported to return True: ``` torch.cuda.is_bf16_supported = lambda: True ``` Next, per recommendation from official PyTorch documentation, place only the forward-pass of the training step in the torch.autocast scope: ``` with torch.autocast(dtype=torch.bfloat16, device_type='cuda'): # forward pass ``` The device type is CUDA because we are using CUDA’s list of BF16 compatible operations as mentioned above. Example showing the original training code snippet: ``` def train_loop_fn(train_loader): for i, data in enumerate(train_loader): inputs = data[0] labels = data[3] outputs = model(inputs, labels=labels) loss = outputs.loss/ flags.grad_acc_steps loss.backward() optimizer.step() xm.mark_step() ``` The following shows the training loop modified to use BF16 autocast: ``` os.environ["NEURON_CC_FLAGS"] = "--auto-cast=none" def train_loop_fn(train_loader): for i, data in enumerate(train_loader): torch.cuda.is_bf16_supported = lambda: True with torch.autocast(dtype=torch.bfloat16, device_type='cuda'): inputs = data[0] labels = data[3] outputs = model(inputs, labels=labels) loss = outputs.loss/ flags.grad_acc_steps loss.backward() optimizer.step() xm.mark_step() ``` For a full example of BF16 mixed-precision, see [PyTorch Neuron BERT Pretraining Tutorial](../../tutorials/training/bert.html#hf-bert-pretraining-tutorial). See official PyTorch documentation for more details about [torch.autocast](https://pytorch.org/docs/stable/amp.html#autocasting) . ## [Tips and Best Practices](#id13)[#](#tips-and-best-practices "Permalink to this headline") ### [Understand the lazy mode in PyTorch Neuron](#id14)[#](#understand-the-lazy-mode-in-pytorch-neuron "Permalink to this headline") One significant difference between PyTorch Neuron and native PyTorch is that the PyTorch Neuron system runs in lazy mode while the native PyTorch runs in eager mode. Tensors in lazy mode are placeholders for building the computational graph until they are materialized after the compilation and evaluation are complete. The PyTorch Neuron system builds the computational graph on the fly when you call PyTorch APIs to build the computation using tensors and operators. The computational graph gets compiled and executed when `xm.mark_step()` is called explicitly or implicitly by `pl.MpDeviceLoader/pl.ParallelLoader`, or when you explicitly request the value of a tensor such as by calling `loss.item()` or `print(loss)`. ### [Minimize the number of compilation-and-executions](#id15)[#](#minimize-the-number-of-compilation-and-executions "Permalink to this headline") For best performance, you should keep in mind the possible ways to initiate compilation-and-executions as described in [Understand the lazy mode in PyTorch/XLA](#understand-the-lazy-mode-in-pytorch-neuron) and should try to minimize the number of compilation-and-executions. Ideally, only one compilation-and-execution is necessary per training iteration and is initiated automatically by `pl.MpDeviceLoader/pl.ParallelLoader`. The `MpDeviceLoader` is optimized for XLA and should always be used if possible for best performance. During training, you might want to examine some intermediate results such as loss values. In such case, the printing of lazy tensors should be wrapped using `xm.add_step_closure()` to avoid unnecessary compilation-and-executions. ### [Ensure common initial weights across workers](#id16)[#](#ensure-common-initial-weights-across-workers "Permalink to this headline") To achieve best accuracy during data parallel training, all workers need to have the same initial parameter states. This can be achieved by using the same seed across the workers. In the case of HuggingFace library, the set\_seed function can be used. ([https://github.com/pytorch/xla/issues/3216](https://github.com/pytorch/xla/issues/3216)). ### [Use PyTorch/XLA’s model save function](#id17)[#](#use-pytorch-xla-s-model-save-function "Permalink to this headline") To avoid problems with saving and loading checkpoints, make sure you use PyTorch/XLA’s model save function to properly checkpoint your model. For more information about the function, see [torch\_xla.core.xla\_model.save](https://pytorch.org/xla/release/1.9/index.html#torch_xla.core.xla_model.save) in the _PyTorch on XLA Devices_ documentation. When training using multiple devices, `xla_model.save` can result in high host memory usage. If you see such high usage causing the host to run out of memory, please use [torch\_xla.utils.serialization.save](https://pytorch.org/xla/release/1.9/index.html#torch_xla.utils.serialization.save) . This would save the model in a serialized manner. When saved using the `serialization.save` api, the model should be loaded using `serialization.load` api. More information on this here: [Saving and Loading Tensors](https://pytorch.org/xla/release/1.9/index.html#saving-and-loading-xla-tensors) ## [FAQ](#id18)[#](#faq "Permalink to this headline") ### [What is the difference between Trainium and Inferentia?](#id19)[#](#what-is-the-difference-between-trainium-and-inferentia "Permalink to this headline") Trainium is an accelerator designed to speed up training, whereas Inferentia is an accelerator designed to speed up inference. ## [Debugging and troubleshooting](#id20)[#](#debugging-and-troubleshooting "Permalink to this headline") To debug on PyTorch Neuron, please follow the debug guide. _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Developer Guide for Training with PyTorch Neuron (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/underscore.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../../_static/contentui.js"></script> <script src="../../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html"> <link rel="search" title="Search" href="../../../../../search.html"> <link rel="next" title="How to debug models in PyTorch Neuron (torch-neuronx)" href="pytorch-neuron-debug.html"> <link rel="prev" title="Developer Guide (torch-neuronx)" href="index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="index.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../../_sources/frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron"> PyTorch Neuron </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-xla-device"> Neuron XLA device </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-single-worker-training-evaluation-quick-start"> PyTorch Neuron single-worker training/evaluation quick-start </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-multi-worker-data-parallel-training-using-torchrun"> PyTorch Neuron multi-worker data parallel training using torchrun </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#conversion-from-distributed-data-parallel-ddp-application"> Conversion from Distributed Data Parallel (DDP) application </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-environment-variables"> PyTorch Neuron environment variables </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-persistent-cache-for-compiled-graphs"> Neuron Persistent Cache for compiled graphs </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#number-of-graphs"> Number of graphs </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#automatic-casting-of-float-tensors-to-bfloat16"> Automatic casting of float tensors to BFloat16 </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#automatic-mixed-precision"> Automatic Mixed-Precision </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bf16-mixed-precision-using-pytorch-autocast"> BF16 mixed-precision using PyTorch Autocast </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tips-and-best-practices"> Tips and Best Practices </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#understand-the-lazy-mode-in-pytorch-neuron"> Understand the lazy mode in PyTorch Neuron </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#minimize-the-number-of-compilation-and-executions"> Minimize the number of compilation-and-executions </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#ensure-common-initial-weights-across-workers"> Ensure common initial weights across workers </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#use-pytorch-xla-s-model-save-function"> Use PyTorch/XLA’s model save function </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#faq"> FAQ </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#what-is-the-difference-between-trainium-and-inferentia"> What is the difference between Trainium and Inferentia? </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#debugging-and-troubleshooting"> Debugging and troubleshooting </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Developer Guide for Training with PyTorch Neuron (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron"> PyTorch Neuron </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-xla-device"> Neuron XLA device </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-single-worker-training-evaluation-quick-start"> PyTorch Neuron single-worker training/evaluation quick-start </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-multi-worker-data-parallel-training-using-torchrun"> PyTorch Neuron multi-worker data parallel training using torchrun </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#conversion-from-distributed-data-parallel-ddp-application"> Conversion from Distributed Data Parallel (DDP) application </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#pytorch-neuron-environment-variables"> PyTorch Neuron environment variables </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-persistent-cache-for-compiled-graphs"> Neuron Persistent Cache for compiled graphs </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#number-of-graphs"> Number of graphs </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#automatic-casting-of-float-tensors-to-bfloat16"> Automatic casting of float tensors to BFloat16 </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#automatic-mixed-precision"> Automatic Mixed-Precision </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#bf16-mixed-precision-using-pytorch-autocast"> BF16 mixed-precision using PyTorch Autocast </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tips-and-best-practices"> Tips and Best Practices </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#understand-the-lazy-mode-in-pytorch-neuron"> Understand the lazy mode in PyTorch Neuron </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#minimize-the-number-of-compilation-and-executions"> Minimize the number of compilation-and-executions </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#ensure-common-initial-weights-across-workers"> Ensure common initial weights across workers </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#use-pytorch-xla-s-model-save-function"> Use PyTorch/XLA’s model save function </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#faq"> FAQ </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#what-is-the-difference-between-trainium-and-inferentia"> What is the difference between Trainium and Inferentia? </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#debugging-and-troubleshooting"> Debugging and troubleshooting </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="developer-guide-for-training-with-pytorch-neuron-torch-neuronx"> <span id="pytorch-neuronx-programming-guide"></span><h1>Developer Guide for Training with PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#developer-guide-for-training-with-pytorch-neuron-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#pytorch-neuron" id="id2">PyTorch Neuron</a></p> <ul> <li><p><a class="reference internal" href="#neuron-xla-device" id="id3">Neuron XLA device</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#pytorch-neuron-single-worker-training-evaluation-quick-start" id="id4">PyTorch Neuron single-worker training/evaluation quick-start</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-multi-worker-data-parallel-training-using-torchrun" id="id5">PyTorch Neuron multi-worker data parallel training using torchrun</a></p></li> <li><p><a class="reference internal" href="#conversion-from-distributed-data-parallel-ddp-application" id="id6">Conversion from Distributed Data Parallel (DDP) application</a></p></li> <li><p><a class="reference internal" href="#pytorch-neuron-environment-variables" id="id7">PyTorch Neuron environment variables</a></p></li> <li><p><a class="reference internal" href="#neuron-persistent-cache-for-compiled-graphs" id="id8">Neuron Persistent Cache for compiled graphs</a></p></li> <li><p><a class="reference internal" href="#number-of-graphs" id="id9">Number of graphs</a></p></li> <li><p><a class="reference internal" href="#automatic-casting-of-float-tensors-to-bfloat16" id="id10">Automatic casting of float tensors to BFloat16</a></p></li> <li><p><a class="reference internal" href="#automatic-mixed-precision" id="id11">Automatic Mixed-Precision</a></p> <ul> <li><p><a class="reference internal" href="#bf16-mixed-precision-using-pytorch-autocast" id="id12">BF16 mixed-precision using PyTorch Autocast</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#tips-and-best-practices" id="id13">Tips and Best Practices</a></p> <ul> <li><p><a class="reference internal" href="#understand-the-lazy-mode-in-pytorch-neuron" id="id14">Understand the lazy mode in PyTorch Neuron</a></p></li> <li><p><a class="reference internal" href="#minimize-the-number-of-compilation-and-executions" id="id15">Minimize the number of compilation-and-executions</a></p></li> <li><p><a class="reference internal" href="#ensure-common-initial-weights-across-workers" id="id16">Ensure common initial weights across workers</a></p></li> <li><p><a class="reference internal" href="#use-pytorch-xla-s-model-save-function" id="id17">Use PyTorch/XLA’s model save function</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#faq" id="id18">FAQ</a></p> <ul> <li><p><a class="reference internal" href="#what-is-the-difference-between-trainium-and-inferentia" id="id19">What is the difference between Trainium and Inferentia?</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#debugging-and-troubleshooting" id="id20">Debugging and troubleshooting</a></p></li> </ul> </div> <p>Trainium is designed to speed up model training and reduce training cost. It is available on the Trn1 instances. Each Trainium accelerator has two NeuronCores, which are the main neural network compute units.</p> <p>PyTorch Neuron enables PyTorch users to train their models on Trainium’s NeuronCores with little code change to their training code. It is based on the <a class="reference external" href="https://pytorch.org/xla">PyTorch/XLA software package</a>.</p> <p>This guide helps you get started with single-worker training and distributed training using PyTorch Neuron.</p> <div class="section" id="pytorch-neuron"> <h2><a class="toc-backref" href="#id2">PyTorch Neuron</a><a class="headerlink" href="#pytorch-neuron" title="Permalink to this headline">#</a></h2> <div class="section" id="neuron-xla-device"> <h3><a class="toc-backref" href="#id3">Neuron XLA device</a><a class="headerlink" href="#neuron-xla-device" title="Permalink to this headline">#</a></h3> <p>With PyTorch Neuron the default XLA device is mapped to a NeuronCore. By default, one NeuronCore is configured. To use Neuron XLA device, specify the device as <code class="docutils literal notranslate"><span class="pre">xm.xla_device()</span></code> or <code class="docutils literal notranslate"><span class="pre">'xla'</span></code>:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> </pre></div> </div> <p>or</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">device</span> <span class="o">=</span> <span class="s1">'xla'</span> </pre></div> </div> <p>PyTorch models and tensors can be mapped to the device as usual:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">model</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">tensor</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> </pre></div> </div> <p>To move tensor back to CPU, do :</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">tensor</span><span class="o">.</span><span class="n">cpu</span><span class="p">()</span> </pre></div> </div> <p>or</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">tensor</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="s1">'cpu'</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="pytorch-neuron-single-worker-training-evaluation-quick-start"> <h2><a class="toc-backref" href="#id4">PyTorch Neuron single-worker training/evaluation quick-start</a><a class="headerlink" href="#pytorch-neuron-single-worker-training-evaluation-quick-start" title="Permalink to this headline">#</a></h2> <p>PyTorch Neuron uses XLA to enable conversion of PyTorch operations to Trainium instructions. To get started on PyTorch Neuron, first modify your <a class="reference internal" href="../../tutorials/training/mlp.html#neuronx-mlp-training-tutorial"><span class="std std-ref">training script</span></a> to use XLA in the same manner as described in <a class="reference external" href="https://pytorch.org/xla">PyTorch/XLA documentation</a> and use XLA device:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="c1"># or</span> <span class="n">device</span> <span class="o">=</span> <span class="s1">'xla'</span> </pre></div> </div> <p>The NeuronCore is mapped to an XLA device. On Trainium instance, the XLA device is automatically mapped to the first available NeuronCore.</p> <p>By default the above steps will enable the training or evaluation script to run on one NeuronCore. NOTE: Each process is mapped to one NeuronCore.</p> <p>Finally, add <code class="docutils literal notranslate"><span class="pre">mark_step</span></code> at the end of the training or evaluation step to compile and execute the training or evaluation step:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> </pre></div> </div> <p>These changes can be placed in control-flows in order to keep the script the same between PyTorch Neuron and CPU/GPU. For example, you can use an environment variable to disable XLA which would cause the script to run in PyTorch native mode (using CPU on Trainium instances and GPU on GPU instances):</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">device</span> <span class="o">=</span> <span class="s1">'cpu'</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"DISABLE_XLA"</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span> <span class="n">device</span> <span class="o">=</span> <span class="s1">'xla'</span> <span class="o">...</span> <span class="c1"># end of training step</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"DISABLE_XLA"</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> </pre></div> </div> <p>More on the need for mark_step is at <a class="reference external" href="#understand-the-lazy-mode-in-pytorch-neuron">Understand the lazy mode in PyTorch Neuron</a>.</p> <p>For a full runnable example, please see the <span class="xref std std-ref">Single-worker MLP training on Trainium tutorial</span>.</p> </div> <div class="section" id="pytorch-neuron-multi-worker-data-parallel-training-using-torchrun"> <h2><a class="toc-backref" href="#id5">PyTorch Neuron multi-worker data parallel training using torchrun</a><a class="headerlink" href="#pytorch-neuron-multi-worker-data-parallel-training-using-torchrun" title="Permalink to this headline">#</a></h2> <p>Data parallel training allows you to replicate your script across multiple workers, each worker processing a proportional portion of the dataset, in order to train faster.</p> <p>To run multiple workers in data parallel configuration, with each worker using one NeuronCore, first add additional imports for parallel dataloader and multi-processing utilities:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch_xla.distributed.parallel_loader</span> <span class="k">as</span> <span class="nn">pl</span> </pre></div> </div> <p>Next we initialize the Neuron distributed context using the XLA backend for torch.distributed:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">torch_xla.distributed.xla_backend</span> <span class="n">torch</span><span class="o">.</span><span class="n">distributed</span><span class="o">.</span><span class="n">init_process_group</span><span class="p">(</span><span class="s1">'xla'</span><span class="p">)</span> </pre></div> </div> <p>Next, replace <code class="docutils literal notranslate"><span class="pre">optimizer.step()</span></code> function call with <code class="docutils literal notranslate"><span class="pre">xm.optimizer_step(optimizer)</span></code> which adds gradient synchronization across workers before taking the optimizer step:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">xm</span><span class="o">.</span><span class="n">optimizer_step</span><span class="p">(</span><span class="n">optimizer</span><span class="p">)</span> </pre></div> </div> <p>If you’re using a distributed dataloader, wrap your dataloader in the PyTorch/XLA’s <code class="docutils literal notranslate"><span class="pre">MpDeviceLoader</span></code> class which provides buffering to hide CPU to device data load latency:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">parallel_loader</span> <span class="o">=</span> <span class="n">pl</span><span class="o">.</span><span class="n">MpDeviceLoader</span><span class="p">(</span><span class="n">dataloader</span><span class="p">,</span> <span class="n">device</span><span class="p">)</span> </pre></div> </div> <p>Within the training code, use xm.xrt_world_size() to get the world size, and xm.get_ordinal to get the global rank of the current process.</p> <p>Then run use <a class="reference external" href="https://pytorch.org/docs/stable/elastic/run.html#launcher-api">PyTorch torchrun</a> utility to run the script. For example, to run 32 worker data parallel training:</p> <p><code class="docutils literal notranslate"><span class="pre">torchrun</span> <span class="pre">--nproc_per_node=32</span> <span class="pre">&lt;script</span> <span class="pre">and</span> <span class="pre">options&gt;</span></code></p> <p>To run on multiple instances, make sure to use trn1.32xlarge instances and use all 32 NeuronCores on each instance. For example, with two instances, on the rank-0 Trn1 host, run with –node_rank=0 using torchrun utility:</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span>--nnodes<span class="o">=</span><span class="m">2</span><span class="w"> </span>--node_rank<span class="o">=</span><span class="m">0</span><span class="w"> </span>--master_addr<span class="o">=</span>&lt;root<span class="w"> </span>IP&gt;<span class="w"> </span>--master_port<span class="o">=</span>&lt;root<span class="w"> </span>port&gt;<span class="w"> </span>&lt;script<span class="w"> </span>and<span class="w"> </span>options&gt; </pre></div> </div> <p>On another Trn1 host, run with –node_rank=1 :</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>torchrun<span class="w"> </span>--nproc_per_node<span class="o">=</span><span class="m">32</span><span class="w"> </span>--nnodes<span class="o">=</span><span class="m">2</span><span class="w"> </span>--node_rank<span class="o">=</span><span class="m">1</span><span class="w"> </span>--master_addr<span class="o">=</span>&lt;root<span class="w"> </span>IP&gt;<span class="w"> </span>--master_port<span class="o">=</span>&lt;root<span class="w"> </span>port&gt;<span class="w"> </span>&lt;script<span class="w"> </span>and<span class="w"> </span>options&gt; </pre></div> </div> <p>It is important to launch rank-0 worker with –node_rank=0 to avoid hang.</p> <p>More information about torchrun can be found PyTorch documentation at <a class="reference external" href="https://pytorch.org/docs/stable/elastic/run.html#launcher-api">https://pytorch.org/docs/stable/elastic/run.html#launcher-api</a> .</p> <p>See the <span class="xref std std-ref">Multi-worker data-parallel MLP training using torchrun tutorial</span> for a full example.</p> </div> <div class="section" id="conversion-from-distributed-data-parallel-ddp-application"> <h2><a class="toc-backref" href="#id6">Conversion from Distributed Data Parallel (DDP) application</a><a class="headerlink" href="#conversion-from-distributed-data-parallel-ddp-application" title="Permalink to this headline">#</a></h2> <p>Distributed Data Parallel (DDP) in torch.distributed module is a wrapper to help convert a single-worker training to distributed training. To convert from torch.distributed Distributed Data Parallel (DDP) application to PyTorch Neuron, first convert the application back to single-worker training, which simply involves removing the DDP wrapper, for example <code class="docutils literal notranslate"><span class="pre">model</span> <span class="pre">=</span> <span class="pre">DDP(model,</span> <span class="pre">device_ids=[rank])</span></code>. After this, follow the previous section to change to multi-worker training.</p> </div> <div class="section" id="pytorch-neuron-environment-variables"> <h2><a class="toc-backref" href="#id7">PyTorch Neuron environment variables</a><a class="headerlink" href="#pytorch-neuron-environment-variables" title="Permalink to this headline">#</a></h2> <p>Environment variables allow modifications to PyTorch Neuron behavior without requiring code change to user script. See <a class="reference internal" href="../../api-reference-guide/training/torch-neuron-envvars.html#pytorch-neuronx-envvars"><span class="std std-ref">PyTorch Neuron environment variables</span></a> for more details.</p> </div> <div class="section" id="neuron-persistent-cache-for-compiled-graphs"> <h2><a class="toc-backref" href="#id8">Neuron Persistent Cache for compiled graphs</a><a class="headerlink" href="#neuron-persistent-cache-for-compiled-graphs" title="Permalink to this headline">#</a></h2> <p>See <a class="reference internal" href="../../../../../general/arch/neuron-features/neuron-caching.html#neuron-caching"><span class="std std-ref">Neuron Persistent Cache for compiled graphs</span></a></p> </div> <div class="section" id="number-of-graphs"> <h2><a class="toc-backref" href="#id9">Number of graphs</a><a class="headerlink" href="#number-of-graphs" title="Permalink to this headline">#</a></h2> <p>PyTorch/XLA converts PyTorch’s eager mode execution to lazy-mode graph-based execution. During this process, there can be multiple graphs compiled and executed if there are extra mark-steps or functions with implicit mark-steps. Additionally, more graphs can be generated if there are different execution paths taken due to control-flows.</p> </div> <div class="section" id="automatic-casting-of-float-tensors-to-bfloat16"> <h2><a class="toc-backref" href="#id10">Automatic casting of float tensors to BFloat16</a><a class="headerlink" href="#automatic-casting-of-float-tensors-to-bfloat16" title="Permalink to this headline">#</a></h2> <p>With PyTorch Neuron, the default behavior is for torch.float (FP32) and torch.double (FP64) tensors to be mapped to torch.float in hardware. To reduce memory footprint and improve performance, torch.float and torch.double tensors can automatically be converted to BFloat16 by setting the environment variable <code class="docutils literal notranslate"><span class="pre">XLA_USE_BF16=1</span></code>. Alternatively, torch.float can automatically be converted to BFloat16 and torch.double converted to FP32 by setting the environment variable <code class="docutils literal notranslate"><span class="pre">XLA_DOWNCAST_BF16=1</span></code>.</p> </div> <div class="section" id="automatic-mixed-precision"> <h2><a class="toc-backref" href="#id11">Automatic Mixed-Precision</a><a class="headerlink" href="#automatic-mixed-precision" title="Permalink to this headline">#</a></h2> <div class="section" id="bf16-mixed-precision-using-pytorch-autocast"> <h3><a class="toc-backref" href="#id12">BF16 mixed-precision using PyTorch Autocast</a><a class="headerlink" href="#bf16-mixed-precision-using-pytorch-autocast" title="Permalink to this headline">#</a></h3> <p>By default, the compiler automatically cast internal FP32 operations to BF16. You can disable this and allow PyTorch’s BF16 mixed-precision to do the casting. PyTorch’s BF16 mixed-precision is achieved by casting certain operations to operate BF16. We currently use CUDA’s list of operations that can operate in BF16:</p> <p>(NOTE: Although convolution is in the list below, it is currently unsupported by Neuron. See <span class="xref std std-ref">model-architecture-fit</span>)</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>_convolution _convolution _convolution_nogroup conv1d conv2d conv3d conv_tbc conv_transpose1d conv_transpose2d conv_transpose3d convolution cudnn_convolution cudnn_convolution_transpose cudnn_convolution cudnn_convolution_transpose cudnn_convolution cudnn_convolution_transpose prelu addmm addmv addr matmul mm mv linear addbmm baddbmm bmm chain_matmul linalg_multi_dot </pre></div> </div> <p>To enable PyTorch’s BF16 mixed-precision, first turn off the Neuron compiler auto-cast:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_CC_FLAGS"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"--auto-cast=none"</span> </pre></div> </div> <p>Next, overwrite torch.cuda.is_bf16_supported to return True:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">torch</span><span class="o">.</span><span class="n">cuda</span><span class="o">.</span><span class="n">is_bf16_supported</span> <span class="o">=</span> <span class="k">lambda</span><span class="p">:</span> <span class="kc">True</span> </pre></div> </div> <p>Next, per recommendation from official PyTorch documentation, place only the forward-pass of the training step in the torch.autocast scope:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">torch</span><span class="o">.</span><span class="n">autocast</span><span class="p">(</span><span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">bfloat16</span><span class="p">,</span> <span class="n">device_type</span><span class="o">=</span><span class="s1">'cuda'</span><span class="p">):</span> <span class="c1"># forward pass</span> </pre></div> </div> <p>The device type is CUDA because we are using CUDA’s list of BF16 compatible operations as mentioned above.</p> <p>Example showing the original training code snippet:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">train_loop_fn</span><span class="p">(</span><span class="n">train_loader</span><span class="p">):</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">data</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">train_loader</span><span class="p">):</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="n">outputs</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">labels</span><span class="o">=</span><span class="n">labels</span><span class="p">)</span> <span class="n">loss</span> <span class="o">=</span> <span class="n">outputs</span><span class="o">.</span><span class="n">loss</span><span class="o">/</span> <span class="n">flags</span><span class="o">.</span><span class="n">grad_acc_steps</span> <span class="n">loss</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">step</span><span class="p">()</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> </pre></div> </div> <p>The following shows the training loop modified to use BF16 autocast:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_CC_FLAGS"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"--auto-cast=none"</span> <span class="k">def</span> <span class="nf">train_loop_fn</span><span class="p">(</span><span class="n">train_loader</span><span class="p">):</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">data</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">train_loader</span><span class="p">):</span> <span class="n">torch</span><span class="o">.</span><span class="n">cuda</span><span class="o">.</span><span class="n">is_bf16_supported</span> <span class="o">=</span> <span class="k">lambda</span><span class="p">:</span> <span class="kc">True</span> <span class="k">with</span> <span class="n">torch</span><span class="o">.</span><span class="n">autocast</span><span class="p">(</span><span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">bfloat16</span><span class="p">,</span> <span class="n">device_type</span><span class="o">=</span><span class="s1">'cuda'</span><span class="p">):</span> <span class="n">inputs</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="n">labels</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="n">outputs</span> <span class="o">=</span> <span class="n">model</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">labels</span><span class="o">=</span><span class="n">labels</span><span class="p">)</span> <span class="n">loss</span> <span class="o">=</span> <span class="n">outputs</span><span class="o">.</span><span class="n">loss</span><span class="o">/</span> <span class="n">flags</span><span class="o">.</span><span class="n">grad_acc_steps</span> <span class="n">loss</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">step</span><span class="p">()</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> </pre></div> </div> <p>For a full example of BF16 mixed-precision, see <a class="reference internal" href="../../tutorials/training/bert.html#hf-bert-pretraining-tutorial"><span class="std std-ref">PyTorch Neuron BERT Pretraining Tutorial</span></a>.</p> <p>See official PyTorch documentation for more details about <a class="reference external" href="https://pytorch.org/docs/stable/amp.html#autocasting">torch.autocast</a> .</p> </div> </div> <div class="section" id="tips-and-best-practices"> <h2><a class="toc-backref" href="#id13">Tips and Best Practices</a><a class="headerlink" href="#tips-and-best-practices" title="Permalink to this headline">#</a></h2> <div class="section" id="understand-the-lazy-mode-in-pytorch-neuron"> <h3><a class="toc-backref" href="#id14">Understand the lazy mode in PyTorch Neuron</a><a class="headerlink" href="#understand-the-lazy-mode-in-pytorch-neuron" title="Permalink to this headline">#</a></h3> <p>One significant difference between PyTorch Neuron and native PyTorch is that the PyTorch Neuron system runs in lazy mode while the native PyTorch runs in eager mode. Tensors in lazy mode are placeholders for building the computational graph until they are materialized after the compilation and evaluation are complete. The PyTorch Neuron system builds the computational graph on the fly when you call PyTorch APIs to build the computation using tensors and operators. The computational graph gets compiled and executed when <code class="docutils literal notranslate"><span class="pre">xm.mark_step()</span></code> is called explicitly or implicitly by <code class="docutils literal notranslate"><span class="pre">pl.MpDeviceLoader/pl.ParallelLoader</span></code>, or when you explicitly request the value of a tensor such as by calling <code class="docutils literal notranslate"><span class="pre">loss.item()</span></code> or <code class="docutils literal notranslate"><span class="pre">print(loss)</span></code>.</p> </div> <div class="section" id="minimize-the-number-of-compilation-and-executions"> <span id="id1"></span><h3><a class="toc-backref" href="#id15">Minimize the number of compilation-and-executions</a><a class="headerlink" href="#minimize-the-number-of-compilation-and-executions" title="Permalink to this headline">#</a></h3> <p>For best performance, you should keep in mind the possible ways to initiate compilation-and-executions as described in <a class="reference external" href="#understand-the-lazy-mode-in-pytorch-neuron">Understand the lazy mode in PyTorch/XLA</a> and should try to minimize the number of compilation-and-executions. Ideally, only one compilation-and-execution is necessary per training iteration and is initiated automatically by <code class="docutils literal notranslate"><span class="pre">pl.MpDeviceLoader/pl.ParallelLoader</span></code>. The <code class="docutils literal notranslate"><span class="pre">MpDeviceLoader</span></code> is optimized for XLA and should always be used if possible for best performance. During training, you might want to examine some intermediate results such as loss values. In such case, the printing of lazy tensors should be wrapped using <code class="docutils literal notranslate"><span class="pre">xm.add_step_closure()</span></code> to avoid unnecessary compilation-and-executions.</p> </div> <div class="section" id="ensure-common-initial-weights-across-workers"> <h3><a class="toc-backref" href="#id16">Ensure common initial weights across workers</a><a class="headerlink" href="#ensure-common-initial-weights-across-workers" title="Permalink to this headline">#</a></h3> <p>To achieve best accuracy during data parallel training, all workers need to have the same initial parameter states. This can be achieved by using the same seed across the workers. In the case of HuggingFace library, the set_seed function can be used. (<a class="reference external" href="https://github.com/pytorch/xla/issues/3216">https://github.com/pytorch/xla/issues/3216</a>).</p> </div> <div class="section" id="use-pytorch-xla-s-model-save-function"> <h3><a class="toc-backref" href="#id17">Use PyTorch/XLA’s model save function</a><a class="headerlink" href="#use-pytorch-xla-s-model-save-function" title="Permalink to this headline">#</a></h3> <p>To avoid problems with saving and loading checkpoints, make sure you use PyTorch/XLA’s model save function to properly checkpoint your model. For more information about the function, see <a class="reference external" href="https://pytorch.org/xla/release/1.9/index.html#torch_xla.core.xla_model.save">torch_xla.core.xla_model.save</a> in the <em>PyTorch on XLA Devices</em> documentation.</p> <p>When training using multiple devices, <code class="docutils literal notranslate"><span class="pre">xla_model.save</span></code> can result in high host memory usage. If you see such high usage causing the host to run out of memory, please use <a class="reference external" href="https://pytorch.org/xla/release/1.9/index.html#torch_xla.utils.serialization.save">torch_xla.utils.serialization.save</a> . This would save the model in a serialized manner. When saved using the <code class="docutils literal notranslate"><span class="pre">serialization.save</span></code> api, the model should be loaded using <code class="docutils literal notranslate"><span class="pre">serialization.load</span></code> api. More information on this here: <a class="reference external" href="https://pytorch.org/xla/release/1.9/index.html#saving-and-loading-xla-tensors">Saving and Loading Tensors</a></p> </div> </div> <div class="section" id="faq"> <h2><a class="toc-backref" href="#id18">FAQ</a><a class="headerlink" href="#faq" title="Permalink to this headline">#</a></h2> <div class="section" id="what-is-the-difference-between-trainium-and-inferentia"> <h3><a class="toc-backref" href="#id19">What is the difference between Trainium and Inferentia?</a><a class="headerlink" href="#what-is-the-difference-between-trainium-and-inferentia" title="Permalink to this headline">#</a></h3> <p>Trainium is an accelerator designed to speed up training, whereas Inferentia is an accelerator designed to speed up inference.</p> </div> </div> <div class="section" id="debugging-and-troubleshooting"> <h2><a class="toc-backref" href="#id20">Debugging and troubleshooting</a><a class="headerlink" href="#debugging-and-troubleshooting" title="Permalink to this headline">#</a></h2> <p>To debug on PyTorch Neuron, please follow the <span class="xref std std-ref">debug guide</span>.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Developer Guide (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="pytorch-neuron-debug.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">How to debug models in PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:10.451Z
Misc (Training - torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/misc-training.html
# Misc (Training - torch-neuronx) — AWS Neuron Documentation previous Developer Guide for Profiling with PyTorch Neuron (`torch-neuronx`)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Misc (Training - torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuronx) - Supported Operators" href="pytorch-neuron-supported-operators.html"> <link rel="prev" title="Developer Guide for Profiling with PyTorch Neuron (torch-neuronx)" href="programming-guide/torch-neuronx-profiling-dev-guide.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/misc-training", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/misc-training.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/misc-training.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuronx/misc-training.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Misc (Training - torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="misc-training-torch-neuronx"> <h1>Misc (Training - torch-neuronx)<a class="headerlink" href="#misc-training-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="pytorch-neuron-supported-operators.html#pytorch-neuron-supported-operators"><span class="std std-ref">PyTorch Neuron (torch-neuronx) - Supported Operators</span></a></p></li> <li><p><a class="reference internal" href="setup-trn1-multi-node-execution.html#setup-trn1-multi-node-execution"><span class="std std-ref">How to prepare trn1.32xlarge for multi-node execution</span></a></p></li> <li><p><a class="reference internal" href="training-troubleshooting.html#pytorch-neuron-traning-troubleshooting"><span class="std std-ref">PyTorch Neuron (torch-neuronx) for Training Troubleshooting Guide</span></a></p></li> <li><p><a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html#torch-neuronx-rn"><span class="std std-ref">PyTorch Neuron (torch-neuronx) release notes</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="programming-guide/torch-neuronx-profiling-dev-guide.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Developer Guide for Profiling with PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="pytorch-neuron-supported-operators.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) - Supported Operators</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:11.248Z
Developer Guide for Profiling with PyTorch Neuron (torch-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html
# Developer Guide for Profiling with PyTorch Neuron (torch-neuronx) — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Developer Guide for Profiling with PyTorch Neuron (`torch-neuronx`)[#](#developer-guide-for-profiling-with-pytorch-neuron-torch-neuronx "Permalink to this headline") Table of Contents - [Introduction](#introduction) - [Example used in this guide](#example-used-in-this-guide) - [Prerequisites](#prerequisites) - [Environment](#environment) - [Setup](#setup) - [Viewing the Trace on TensorBoard](#viewing-the-trace-on-tensorboard) - [Using Named Blocks for the Trace](#using-named-blocks-for-the-trace) ## [Introduction](#id1)[#](#introduction "Permalink to this headline") The Neuron PyTorch profiler is a context manager wrapping around the entire model and training loop. Specifically this is the context manager: `torch_neuronx.experimental.profiler.profile`. This is a wrapper of the XLA Debug Profiler which we imported earlier as `import torch_xla.debug.profiler as xp`, and is backwards-compatible. Here are the parameters of the profiler context manager: 1. `port`: Port to run the profiling GRPC server on. Default is 9012. 2. `profile_type`: There is “trace” and “operator”. “trace” is the Torch Runtime Trace Level, while “operator” is the Model Operator Trace Level. 3. `ms_duration`: This defines how long the profiler will capture the HLO artifacts from the model to view in the profiler. The unit is in milliseconds. 4. `neuron_tensorboard_plugin_dir`: The directory the neuron tensorboard plugin will file write to (NB: Assumes that the tensorboard logdir=”log/”) 5. `delete_working`: If set to False turns off the deletion of temporary files (default True) We move the model to the xla device _inside the context manager._ This is important, as this allows the profiler to collect the operations and processes from the `neuronx-cc` compiler artifacts. If the model is moved to the xla device outside of the context manager, the profiling won’t work. Note The warnings about the `XLA_IR_DEBUG` and `XLA_HLO_DEBUG` env vars not being set can be ignored for the most part. This warning only comes into play when compiling the model for Neuron outside of the profiler context manager. After running this script, notice a `./logs` directory has been created. It contains the TensorBoard logs including the profiler views. ## [Example used in this guide](#id2)[#](#example-used-in-this-guide "Permalink to this headline") We will use the following code sample to describe in detail how to use the Neuron PyTorch profiling API. ### [Environment](#id4)[#](#environment "Permalink to this headline") ``` #activate python virtual environment and install tensorboard_plugin_neuron source ~/aws_neuron_venv_pytorch_p38/bin/activate pip install tensorboard_plugin_neuronx #create work directory for the Neuron Profiling tutorials mkdir -p ~/neuron_profiling_tensorboard_examples cd ~/neuron_profiling_tensorboard_examples ``` ### [Setup](#id5)[#](#setup "Permalink to this headline") Create a new working directory: ``` mkdir simple_demo cd simple_demo ``` Save the following code as `demo.py`: ``` import os import torch import torch.nn as nn import torch.nn.functional as F # XLA imports import torch_xla import torch_xla.core.xla_model as xm import torch_xla.debug.profiler as xp import torch_neuronx from torch_neuronx.experimental import profiler os.environ["NEURON_CC_FLAGS"] = "--cache_dir=./compiler_cache" # Global constants EPOCHS = 10 # Declare 3-layer MLP Model class MLP(nn.Module): def __init__(self, input_size = 10, output_size = 2, layers = [5, 5]): super(MLP, self).__init__() self.fc1 = nn.Linear(input_size, layers[0]) self.fc2 = nn.Linear(layers[0], layers[1]) self.fc3 = nn.Linear(layers[1], output_size) def forward(self, x): x = F.relu(self.fc1(x)) x = F.relu(self.fc2(x)) x = self.fc3(x) return F.log_softmax(x, dim=1) def main(): # Fix the random number generator seeds for reproducibility torch.manual_seed(0) # XLA: Specify XLA device (defaults to a NeuronCore on Trn1 instance) device = xm.xla_device() # Start the proflier context-manager with torch_neuronx.experimental.profiler.profile( port=9012, profile_type='trace', ms_duration=15000 ) as profiler: # IMPORTANT: the model has to be transferred to XLA within # the context manager, otherwise profiling won't work model = MLP().to(device) optimizer = torch.optim.SGD(model.parameters(), lr=0.01) loss_fn = torch.nn.NLLLoss() # start training loop print('----------Training ---------------') model.train() for epoch in range(EPOCHS): optimizer.zero_grad() train_x = torch.randn(1,10).to(device) train_label = torch.tensor([1]).to(device) #forward loss = loss_fn(model(train_x), train_label) #back loss.backward() optimizer.step() # XLA: collect ops and run them in XLA runtime xm.mark_step() print('----------End Training ---------------') if __name__ == '__main__': main() ``` Then run it! ## [Viewing the Trace on TensorBoard](#id6)[#](#viewing-the-trace-on-tensorboard "Permalink to this headline") To view the TensorBoard logs, run `tensorboard --logdir=./logs` Note Depending on TensorBoard version `--load_fast=false` might be an additional parameter to add to view the trace. Take note of the port (usually 6006) and enter `localhost:<port>` into the local browser (assuming port forwarding is set up properly): ![tensorboard-url-image](../../../../_images/Neuron_Profiler_Tensorboard_Url.jpg) Once `localhost:<port>` is entered, verify that the “NEURON” view is shown: ![tensorboard-NEURON-header](../../../../_images/Neuron_Profiler_Tensorboard_Header.jpg) If “NEURON” isn’t shown on the top left hand side, select “NEURON” from the drop down on the top right hand side ![tensorboard-NEURON-dropdown](../../../../_images/Neuron_Profiler_Tensorboard_Dropdown.jpg) On the Left Hand Side, there are two dropdown menus: Run & Tool. ![tensorboard-run-tool-dropdowns](../../../../_images/Neuron_Profiler_Tensorboard_Run_Tool_Dropdowns.jpg) The Run dropdown would contain the Torch Runtime Trace and Operator Level Trace views; however since we only ran the “trace” (i.e Torch Runtime Trace Level), we’ll only see that log. The Torch Runtime Trace views are simply dates in `year_month_day_hour_minute_second_millisecond` format. The Tool Dropdown only contains the “trace“ option. The trace view should look like this: ![tensorboard-run-trace-original](../../../../_images/Neuron_Profiler_Runtime_Trace_Original.jpg) Let’s zoom into the following section of the trace: ![tensorboard-run-trace-selected-section](../../../../_images/Neuron_Profiler_Runtime_Trace_Section_Selection.jpg) After zooming in the trace should look like this: ![tensorboard-run-trace-selected-section-zoomed](../../../../_images/Neuron_Profiler_Runtime_Trace_Section_Selection_Zoomed.jpg) Notice on the top, there is a `StepMarker` process followed by `NeuronDevice Execution` process. This correlates to the `xm.mark_step()` call which executes the collected graph of our model on Neuron. For the Operator Level Trace (“operator”), we’ll be profiling the model operators that occur on Neuron. In other words, the profiler will zoom into the `NeuronDevice Execution` process, if the user specifies `profile_type='trace'`. ## [Using Named Blocks for the Trace](#id7)[#](#using-named-blocks-for-the-trace "Permalink to this headline") What we’ve produced so far is the default behavior of the profiler, however it would be more useful to profile specific blocks of our code to narrow down onto performance bottlenecks. To do this, use `xp.Trace` context manager. Replace the respective code in the training loop with the following: ``` ... optimizer.zero_grad() train_x = torch.randn(1,10).to(device) train_label = torch.tensor([1]).to(device) with xp.Trace("model_build"): loss = loss_fn(model(train_x), train_label) with xp.Trace("loss_backward"): loss.backward() with xp.Trace("optimizer_step"): optimizer.step() # XLA: collect ops and run them in XLA runtime xm.mark_step() ... ``` Run the script, and follow the same TensorBoard steps. Afterwards, the trace should look like this: ![tensorboard-run-trace-selected-section-zoomed-named-traces](../../../../_images/Neuron_Profiler_Runtime_Trace_Section_Selection_Zoomed_Named_Traces.jpg) As seen, the `model_build`, `loss_backward` and `optimizer_step` sections have been profiled. Note If you are running your training script in a docker container, to view the tensorboard, you should launch the docker container using flag: `—network host` eg. `docker run —network host my_image:my_tag` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Developer Guide for Profiling with PyTorch Neuron (torch-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Misc (Training - torch-neuronx)" href="../misc-training.html"> <link rel="prev" title="How to debug models in PyTorch Neuron (torch-neuronx)" href="training/pytorch-neuron-debug.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="training/index.html"> Developer Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"><!-- Inserted RTD Footer --> <div class="injected"> <div class="rst-versions rst-badge" data-toggle="rst-versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book">&nbsp;</span> v: v2.14.1 <span class="fa fa-caret-down"></span> </span> <div class="rst-other-versions"> <dl> <dt>Versions</dt> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">latest</a> </dd> <dd class="rtd-current-item"> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.14.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.14.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.13.2/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.13.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.13.1/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.13.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.13.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.13.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.12.2/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.12.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.12.1/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.12.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.12.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.12.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.11.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.11.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.10.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.10.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.9.1/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.9.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.9.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.9.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.8.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.8.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.7.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.7.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.6.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.6.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.5.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.5.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.4.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.4.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v2.3.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v2.3.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.19.2/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.19.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.19.1/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.19.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.19.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.19.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.18.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.18.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.17.2/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.17.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.17.1/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.17.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.17.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.17.0</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.3/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.16.3</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.2/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.16.2</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.1/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.16.1</a> </dd> <dd> <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/v1.16.0/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html">v1.16.0</a> </dd> </dl> <dl> <dt>Downloads</dt> <dd><a href="//awsdocs-neuron.readthedocs-hosted.com/_/downloads/en/v2.14.1/pdf/">PDF</a></dd> </dl> <dl> <dt>On GitHub</dt> <dd> <a href="https://github.com/aws/aws-neuron-sdk/blob/v2.14.1//frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.rst">View</a> </dd> </dl> <hr> <div> <div> Documentation hosted by <a href="https://readthedocs.com">Read the Docs</a> </div> </div> </div> </div> </div> </div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-used-in-this-guide"> Example used in this guide </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#prerequisites"> Prerequisites </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#environment"> Environment </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup"> Setup </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#viewing-the-trace-on-tensorboard"> Viewing the Trace on TensorBoard </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#using-named-blocks-for-the-trace"> Using Named Blocks for the Trace </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Developer Guide for Profiling with PyTorch Neuron (torch-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#introduction"> Introduction </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-used-in-this-guide"> Example used in this guide </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#prerequisites"> Prerequisites </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#environment"> Environment </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#setup"> Setup </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#viewing-the-trace-on-tensorboard"> Viewing the Trace on TensorBoard </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#using-named-blocks-for-the-trace"> Using Named Blocks for the Trace </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="developer-guide-for-profiling-with-pytorch-neuron-torch-neuronx"> <span id="torch-neuronx-dev-guide"></span><h1>Developer Guide for Profiling with PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)<a class="headerlink" href="#developer-guide-for-profiling-with-pytorch-neuron-torch-neuronx" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#introduction" id="id1">Introduction</a></p></li> <li><p><a class="reference internal" href="#example-used-in-this-guide" id="id2">Example used in this guide</a></p> <ul> <li><p><a class="reference internal" href="#prerequisites" id="id3">Prerequisites</a></p></li> <li><p><a class="reference internal" href="#environment" id="id4">Environment</a></p></li> <li><p><a class="reference internal" href="#setup" id="id5">Setup</a></p></li> </ul> </li> <li><p><a class="reference internal" href="#viewing-the-trace-on-tensorboard" id="id6">Viewing the Trace on TensorBoard</a></p></li> <li><p><a class="reference internal" href="#using-named-blocks-for-the-trace" id="id7">Using Named Blocks for the Trace</a></p></li> </ul> </div> <div class="section" id="introduction"> <h2><a class="toc-backref" href="#id1">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">#</a></h2> <p>The Neuron PyTorch profiler is a context manager wrapping around the entire model and training loop. Specifically this is the context manager: <code class="docutils literal notranslate"><span class="pre">torch_neuronx.experimental.profiler.profile</span></code>. This is a wrapper of the XLA Debug Profiler which we imported earlier as <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">torch_xla.debug.profiler</span> <span class="pre">as</span> <span class="pre">xp</span></code>, and is backwards-compatible. Here are the parameters of the profiler context manager:</p> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">port</span></code>: Port to run the profiling GRPC server on. Default is 9012.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">profile_type</span></code>: There is “trace” and “operator”. “trace” is the Torch Runtime Trace Level, while “operator” is the Model Operator Trace Level.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">ms_duration</span></code>: This defines how long the profiler will capture the HLO artifacts from the model to view in the profiler. The unit is in milliseconds.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">neuron_tensorboard_plugin_dir</span></code>: The directory the neuron tensorboard plugin will file write to (NB: Assumes that the tensorboard logdir=”log/”)</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">delete_working</span></code>: If set to False turns off the deletion of temporary files (default True)</p></li> </ol> <p>We move the model to the xla device <em>inside the context manager.</em> This is important, as this allows the profiler to collect the operations and processes from the <code class="docutils literal notranslate"><span class="pre">neuronx-cc</span></code> compiler artifacts. If the model is moved to the xla device outside of the context manager, the profiling won’t work.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The warnings about the <code class="docutils literal notranslate"><span class="pre">XLA_IR_DEBUG</span></code> and <code class="docutils literal notranslate"><span class="pre">XLA_HLO_DEBUG</span></code> env vars not being set can be ignored for the most part. This warning only comes into play when compiling the model for Neuron outside of the profiler context manager.</p> </div> <p>After running this script, notice a <code class="docutils literal notranslate"><span class="pre">./logs</span></code> directory has been created. It contains the TensorBoard logs including the profiler views.</p> </div> <div class="section" id="example-used-in-this-guide"> <h2><a class="toc-backref" href="#id2">Example used in this guide</a><a class="headerlink" href="#example-used-in-this-guide" title="Permalink to this headline">#</a></h2> <p>We will use the following code sample to describe in detail how to use the Neuron PyTorch profiling API.</p> <div class="section" id="prerequisites"> <h3><a class="toc-backref" href="#id3">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Initial <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/torch/torch-neuronx/setup/pytorch-install.html">Trn1 setup for PyTorch (torch-neuronx)</a> has been done</p></li> </ol> </div> <div class="section" id="environment"> <h3><a class="toc-backref" href="#id4">Environment</a><a class="headerlink" href="#environment" title="Permalink to this headline">#</a></h3> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1">#activate python virtual environment and install tensorboard_plugin_neuron</span> <span class="n">source</span> <span class="o">~/</span><span class="n">aws_neuron_venv_pytorch_p38</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span> <span class="n">pip</span> <span class="n">install</span> <span class="n">tensorboard_plugin_neuronx</span> <span class="c1">#create work directory for the Neuron Profiling tutorials</span> <span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="o">~/</span><span class="n">neuron_profiling_tensorboard_examples</span> <span class="n">cd</span> <span class="o">~/</span><span class="n">neuron_profiling_tensorboard_examples</span> </pre></div> </div> </div> <div class="section" id="setup"> <h3><a class="toc-backref" href="#id5">Setup</a><a class="headerlink" href="#setup" title="Permalink to this headline">#</a></h3> <p>Create a new working directory:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">simple_demo</span> <span class="n">cd</span> <span class="n">simple_demo</span> </pre></div> </div> <p>Save the following code as <code class="docutils literal notranslate"><span class="pre">demo.py</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span> <span class="kn">import</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="nn">torch.nn</span> <span class="k">as</span> <span class="nn">nn</span> <span class="kn">import</span> <span class="nn">torch.nn.functional</span> <span class="k">as</span> <span class="nn">F</span> <span class="c1"># XLA imports</span> <span class="kn">import</span> <span class="nn">torch_xla</span> <span class="kn">import</span> <span class="nn">torch_xla.core.xla_model</span> <span class="k">as</span> <span class="nn">xm</span> <span class="kn">import</span> <span class="nn">torch_xla.debug.profiler</span> <span class="k">as</span> <span class="nn">xp</span> <span class="kn">import</span> <span class="nn">torch_neuronx</span> <span class="kn">from</span> <span class="nn">torch_neuronx.experimental</span> <span class="kn">import</span> <span class="n">profiler</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_CC_FLAGS"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"--cache_dir=./compiler_cache"</span> <span class="c1"># Global constants</span> <span class="n">EPOCHS</span> <span class="o">=</span> <span class="mi">10</span> <span class="c1"># Declare 3-layer MLP Model</span> <span class="k">class</span> <span class="nc">MLP</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">input_size</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span> <span class="n">output_size</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span> <span class="n">layers</span> <span class="o">=</span> <span class="p">[</span><span class="mi">5</span><span class="p">,</span> <span class="mi">5</span><span class="p">]):</span> <span class="nb">super</span><span class="p">(</span><span class="n">MLP</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc1</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">input_size</span><span class="p">,</span> <span class="n">layers</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc2</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">layers</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">layers</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc3</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="n">layers</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">output_size</span><span class="p">)</span> <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> <span class="n">x</span> <span class="o">=</span> <span class="n">F</span><span class="o">.</span><span class="n">relu</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fc1</span><span class="p">(</span><span class="n">x</span><span class="p">))</span> <span class="n">x</span> <span class="o">=</span> <span class="n">F</span><span class="o">.</span><span class="n">relu</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fc2</span><span class="p">(</span><span class="n">x</span><span class="p">))</span> <span class="n">x</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fc3</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">return</span> <span class="n">F</span><span class="o">.</span><span class="n">log_softmax</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span> <span class="c1"># Fix the random number generator seeds for reproducibility</span> <span class="n">torch</span><span class="o">.</span><span class="n">manual_seed</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># XLA: Specify XLA device (defaults to a NeuronCore on Trn1 instance)</span> <span class="n">device</span> <span class="o">=</span> <span class="n">xm</span><span class="o">.</span><span class="n">xla_device</span><span class="p">()</span> <span class="c1"># Start the proflier context-manager</span> <span class="k">with</span> <span class="n">torch_neuronx</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">profiler</span><span class="o">.</span><span class="n">profile</span><span class="p">(</span> <span class="n">port</span><span class="o">=</span><span class="mi">9012</span><span class="p">,</span> <span class="n">profile_type</span><span class="o">=</span><span class="s1">'trace'</span><span class="p">,</span> <span class="n">ms_duration</span><span class="o">=</span><span class="mi">15000</span> <span class="p">)</span> <span class="k">as</span> <span class="n">profiler</span><span class="p">:</span> <span class="c1"># IMPORTANT: the model has to be transferred to XLA within</span> <span class="c1"># the context manager, otherwise profiling won't work</span> <span class="n">model</span> <span class="o">=</span> <span class="n">MLP</span><span class="p">()</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">optimizer</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">optim</span><span class="o">.</span><span class="n">SGD</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">parameters</span><span class="p">(),</span> <span class="n">lr</span><span class="o">=</span><span class="mf">0.01</span><span class="p">)</span> <span class="n">loss_fn</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">NLLLoss</span><span class="p">()</span> <span class="c1"># start training loop</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'----------Training ---------------'</span><span class="p">)</span> <span class="n">model</span><span class="o">.</span><span class="n">train</span><span class="p">()</span> <span class="k">for</span> <span class="n">epoch</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">EPOCHS</span><span class="p">):</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">zero_grad</span><span class="p">()</span> <span class="n">train_x</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">10</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">train_label</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([</span><span class="mi">1</span><span class="p">])</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="c1">#forward</span> <span class="n">loss</span> <span class="o">=</span> <span class="n">loss_fn</span><span class="p">(</span><span class="n">model</span><span class="p">(</span><span class="n">train_x</span><span class="p">),</span> <span class="n">train_label</span><span class="p">)</span> <span class="c1">#back</span> <span class="n">loss</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">step</span><span class="p">()</span> <span class="c1"># XLA: collect ops and run them in XLA runtime</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'----------End Training ---------------'</span><span class="p">)</span> <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span> <span class="n">main</span><span class="p">()</span> </pre></div> </div> <p>Then run it!</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">demo</span><span class="o">.</span><span class="n">py</span> </pre></div> </div> </div> </div> <div class="section" id="viewing-the-trace-on-tensorboard"> <span id="tensorboard-interface-overview"></span><h2><a class="toc-backref" href="#id6">Viewing the Trace on TensorBoard</a><a class="headerlink" href="#viewing-the-trace-on-tensorboard" title="Permalink to this headline">#</a></h2> <p>To view the TensorBoard logs, run <code class="docutils literal notranslate"><span class="pre">tensorboard</span> <span class="pre">--logdir=./logs</span></code></p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Depending on TensorBoard version <code class="docutils literal notranslate"><span class="pre">--load_fast=false</span></code> might be an additional parameter to add to view the trace.</p> </div> <p>Take note of the port (usually 6006) and enter <code class="docutils literal notranslate"><span class="pre">localhost:&lt;port&gt;</span></code> into the local browser (assuming port forwarding is set up properly):</p> <p><img alt="tensorboard-url-image" src="../../../../_images/Neuron_Profiler_Tensorboard_Url.jpg"></p> <p>Once <code class="docutils literal notranslate"><span class="pre">localhost:&lt;port&gt;</span></code> is entered, verify that the “NEURON” view is shown:</p> <p><img alt="tensorboard-NEURON-header" src="../../../../_images/Neuron_Profiler_Tensorboard_Header.jpg"></p> <p>If “NEURON” isn’t shown on the top left hand side, select “NEURON” from the drop down on the top right hand side</p> <p><img alt="tensorboard-NEURON-dropdown" src="../../../../_images/Neuron_Profiler_Tensorboard_Dropdown.jpg"></p> <p>On the Left Hand Side, there are two dropdown menus: Run &amp; Tool.</p> <p><img alt="tensorboard-run-tool-dropdowns" src="../../../../_images/Neuron_Profiler_Tensorboard_Run_Tool_Dropdowns.jpg"></p> <p>The Run dropdown would contain the Torch Runtime Trace and Operator Level Trace views; however since we only ran the “trace” (i.e Torch Runtime Trace Level), we’ll only see that log. The Torch Runtime Trace views are simply dates in <code class="docutils literal notranslate"><span class="pre">year_month_day_hour_minute_second_millisecond</span></code> format. The Tool Dropdown only contains the “trace“ option.</p> <p>The trace view should look like this:</p> <p><img alt="tensorboard-run-trace-original" src="../../../../_images/Neuron_Profiler_Runtime_Trace_Original.jpg"></p> <p>Let’s zoom into the following section of the trace:</p> <p><img alt="tensorboard-run-trace-selected-section" src="../../../../_images/Neuron_Profiler_Runtime_Trace_Section_Selection.jpg"></p> <p>After zooming in the trace should look like this:</p> <p><img alt="tensorboard-run-trace-selected-section-zoomed" src="../../../../_images/Neuron_Profiler_Runtime_Trace_Section_Selection_Zoomed.jpg"></p> <p>Notice on the top, there is a <code class="docutils literal notranslate"><span class="pre">StepMarker</span></code> process followed by <code class="docutils literal notranslate"><span class="pre">NeuronDevice</span> <span class="pre">Execution</span></code> process. This correlates to the <code class="docutils literal notranslate"><span class="pre">xm.mark_step()</span></code> call which executes the collected graph of our model on Neuron. For the Operator Level Trace (“operator”), we’ll be profiling the model operators that occur on Neuron. In other words, the profiler will zoom into the <code class="docutils literal notranslate"><span class="pre">NeuronDevice</span> <span class="pre">Execution</span></code> process, if the user specifies <code class="docutils literal notranslate"><span class="pre">profile_type='trace'</span></code>.</p> </div> <div class="section" id="using-named-blocks-for-the-trace"> <h2><a class="toc-backref" href="#id7">Using Named Blocks for the Trace</a><a class="headerlink" href="#using-named-blocks-for-the-trace" title="Permalink to this headline">#</a></h2> <p>What we’ve produced so far is the default behavior of the profiler, however it would be more useful to profile specific blocks of our code to narrow down onto performance bottlenecks. To do this, use <code class="docutils literal notranslate"><span class="pre">xp.Trace</span></code> context manager. Replace the respective code in the training loop with the following:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">zero_grad</span><span class="p">()</span> <span class="n">train_x</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">10</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="n">train_label</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">([</span><span class="mi">1</span><span class="p">])</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">device</span><span class="p">)</span> <span class="k">with</span> <span class="n">xp</span><span class="o">.</span><span class="n">Trace</span><span class="p">(</span><span class="s2">"model_build"</span><span class="p">):</span> <span class="n">loss</span> <span class="o">=</span> <span class="n">loss_fn</span><span class="p">(</span><span class="n">model</span><span class="p">(</span><span class="n">train_x</span><span class="p">),</span> <span class="n">train_label</span><span class="p">)</span> <span class="k">with</span> <span class="n">xp</span><span class="o">.</span><span class="n">Trace</span><span class="p">(</span><span class="s2">"loss_backward"</span><span class="p">):</span> <span class="n">loss</span><span class="o">.</span><span class="n">backward</span><span class="p">()</span> <span class="k">with</span> <span class="n">xp</span><span class="o">.</span><span class="n">Trace</span><span class="p">(</span><span class="s2">"optimizer_step"</span><span class="p">):</span> <span class="n">optimizer</span><span class="o">.</span><span class="n">step</span><span class="p">()</span> <span class="c1"># XLA: collect ops and run them in XLA runtime</span> <span class="n">xm</span><span class="o">.</span><span class="n">mark_step</span><span class="p">()</span> <span class="o">...</span> </pre></div> </div> <p>Run the script, and follow the same TensorBoard steps. Afterwards, the trace should look like this:</p> <p><img alt="tensorboard-run-trace-selected-section-zoomed-named-traces" src="../../../../_images/Neuron_Profiler_Runtime_Trace_Section_Selection_Zoomed_Named_Traces.jpg"></p> <p>As seen, the <code class="docutils literal notranslate"><span class="pre">model_build</span></code>, <code class="docutils literal notranslate"><span class="pre">loss_backward</span></code> and <code class="docutils literal notranslate"><span class="pre">optimizer_step</span></code> sections have been profiled.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>If you are running your training script in a docker container, to view the tensorboard, you should launch the docker container using flag: <code class="docutils literal notranslate"><span class="pre">—network</span> <span class="pre">host</span></code> eg. <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">run</span> <span class="pre">—network</span> <span class="pre">host</span> <span class="pre">my_image:my_tag</span></code></p> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="training/pytorch-neuron-debug.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">How to debug models in PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../misc-training.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Misc (Training - torch-neuronx)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:11.447Z
PyTorch Neuron (torch-neuronx) - Supported Operators — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html
# PyTorch Neuron (torch-neuronx) - Supported Operators — AWS Neuron Documentation Toggle in-page Table of Contents Contents - [Operator support](#operator-support) ## Contents - [Operator support](#operator-support) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## PyTorch Neuron (`torch-neuronx`) - Supported Operators[#](#pytorch-neuron-torch-neuronx-supported-operators "Permalink to this headline") Table of Contents - [Operator support](#operator-support) ## [Operator support](#id1)[#](#operator-support "Permalink to this headline") The following list the aten operators supported by torch-neuronx. <table class="table"><colgroup><col> </colgroup><tbody><tr class="row-odd"><td><p>aten::_s_where</p></td></tr><tr class="row-even"><td><p>aten::_softmax</p></td></tr><tr class="row-odd"><td><p>aten::_softmax_backward_data</p></td></tr><tr class="row-even"><td><p>aten::_unsafe_view</p></td></tr><tr class="row-odd"><td><p>aten::add</p></td></tr><tr class="row-even"><td><p>aten::addcdiv_</p></td></tr><tr class="row-odd"><td><p>aten::addcmul</p></td></tr><tr class="row-even"><td><p>aten::addmm</p></td></tr><tr class="row-odd"><td><p>aten::bernoulli_</p></td></tr><tr class="row-even"><td><p>aten::bmm</p></td></tr><tr class="row-odd"><td><p>aten::constant_pad_nd</p></td></tr><tr class="row-even"><td><p>aten::div</p></td></tr><tr class="row-odd"><td><p>aten::embedding</p></td></tr><tr class="row-even"><td><p>aten::embedding_dense_backward</p></td></tr><tr class="row-odd"><td><p>aten::empty</p></td></tr><tr class="row-even"><td><p>aten::expand</p></td></tr><tr class="row-odd"><td><p>aten::fill_</p></td></tr><tr class="row-even"><td><p>aten::index_select</p></td></tr><tr class="row-odd"><td><p>aten::_log_softmax</p></td></tr><tr class="row-even"><td><p>aten::_log_softmax_backward_data</p></td></tr><tr class="row-odd"><td><p>aten::lt</p></td></tr><tr class="row-even"><td><p>aten::mm</p></td></tr><tr class="row-odd"><td><p>aten::mul</p></td></tr><tr class="row-even"><td><p>aten::native_batch_norm</p></td></tr><tr class="row-odd"><td><p>aten::native_batch_norm_backward</p></td></tr><tr class="row-even"><td><p>aten::neg</p></td></tr><tr class="row-odd"><td><p>aten::permute</p></td></tr><tr class="row-even"><td><p>aten::relu</p></td></tr><tr class="row-odd"><td><p>aten::rsub</p></td></tr><tr class="row-even"><td><p>aten::select</p></td></tr><tr class="row-odd"><td><p>aten::slice</p></td></tr><tr class="row-even"><td><p>aten::sqrt</p></td></tr><tr class="row-odd"><td><p>aten::sum</p></td></tr><tr class="row-even"><td><p>aten::t</p></td></tr><tr class="row-odd"><td><p>aten::tanh</p></td></tr><tr class="row-even"><td><p>aten::tanh_backward</p></td></tr><tr class="row-odd"><td><p>aten::threshold_backward</p></td></tr><tr class="row-even"><td><p>aten::transpose</p></td></tr><tr class="row-odd"><td><p>aten::unsqueeze</p></td></tr><tr class="row-even"><td><p>aten::view</p></td></tr><tr class="row-odd"><td><p>aten::zero_</p></td></tr></tbody></table> _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuronx) - Supported Operators — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="How to prepare trn1.32xlarge for multi-node execution" href="setup-trn1-multi-node-execution.html"> <link rel="prev" title="Misc (Training - torch-neuronx)" href="misc-training.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="misc-training.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#operator-support"> Operator support </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuronx) - Supported Operators</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#operator-support"> Operator support </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-torch-neuronx-supported-operators"> <span id="pytorch-neuron-supported-operators"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) - Supported Operators<a class="headerlink" href="#pytorch-neuron-torch-neuronx-supported-operators" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#operator-support" id="id1">Operator support</a></p></li> </ul> </div> <div class="section" id="operator-support"> <h2><a class="toc-backref" href="#id1">Operator support</a><a class="headerlink" href="#operator-support" title="Permalink to this headline">#</a></h2> <p>The following list the aten operators supported by torch-neuronx.</p> <table class="table"> <colgroup> <col style="width: 100%"> </colgroup> <tbody> <tr class="row-odd"><td><p>aten::_s_where</p></td> </tr> <tr class="row-even"><td><p>aten::_softmax</p></td> </tr> <tr class="row-odd"><td><p>aten::_softmax_backward_data</p></td> </tr> <tr class="row-even"><td><p>aten::_unsafe_view</p></td> </tr> <tr class="row-odd"><td><p>aten::add</p></td> </tr> <tr class="row-even"><td><p>aten::addcdiv_</p></td> </tr> <tr class="row-odd"><td><p>aten::addcmul</p></td> </tr> <tr class="row-even"><td><p>aten::addmm</p></td> </tr> <tr class="row-odd"><td><p>aten::bernoulli_</p></td> </tr> <tr class="row-even"><td><p>aten::bmm</p></td> </tr> <tr class="row-odd"><td><p>aten::constant_pad_nd</p></td> </tr> <tr class="row-even"><td><p>aten::div</p></td> </tr> <tr class="row-odd"><td><p>aten::embedding</p></td> </tr> <tr class="row-even"><td><p>aten::embedding_dense_backward</p></td> </tr> <tr class="row-odd"><td><p>aten::empty</p></td> </tr> <tr class="row-even"><td><p>aten::expand</p></td> </tr> <tr class="row-odd"><td><p>aten::fill_</p></td> </tr> <tr class="row-even"><td><p>aten::index_select</p></td> </tr> <tr class="row-odd"><td><p>aten::_log_softmax</p></td> </tr> <tr class="row-even"><td><p>aten::_log_softmax_backward_data</p></td> </tr> <tr class="row-odd"><td><p>aten::lt</p></td> </tr> <tr class="row-even"><td><p>aten::mm</p></td> </tr> <tr class="row-odd"><td><p>aten::mul</p></td> </tr> <tr class="row-even"><td><p>aten::native_batch_norm</p></td> </tr> <tr class="row-odd"><td><p>aten::native_batch_norm_backward</p></td> </tr> <tr class="row-even"><td><p>aten::neg</p></td> </tr> <tr class="row-odd"><td><p>aten::permute</p></td> </tr> <tr class="row-even"><td><p>aten::relu</p></td> </tr> <tr class="row-odd"><td><p>aten::rsub</p></td> </tr> <tr class="row-even"><td><p>aten::select</p></td> </tr> <tr class="row-odd"><td><p>aten::slice</p></td> </tr> <tr class="row-even"><td><p>aten::sqrt</p></td> </tr> <tr class="row-odd"><td><p>aten::sum</p></td> </tr> <tr class="row-even"><td><p>aten::t</p></td> </tr> <tr class="row-odd"><td><p>aten::tanh</p></td> </tr> <tr class="row-even"><td><p>aten::tanh_backward</p></td> </tr> <tr class="row-odd"><td><p>aten::threshold_backward</p></td> </tr> <tr class="row-even"><td><p>aten::transpose</p></td> </tr> <tr class="row-odd"><td><p>aten::unsqueeze</p></td> </tr> <tr class="row-even"><td><p>aten::view</p></td> </tr> <tr class="row-odd"><td><p>aten::zero_</p></td> </tr> </tbody> </table> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="misc-training.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Misc (Training - torch-neuronx)</p> </div> </a> <a class="right-next" id="next-link" href="setup-trn1-multi-node-execution.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">How to prepare trn1.32xlarge for multi-node execution</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:11.689Z
How to prepare trn1.32xlarge for multi-node execution — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html
# How to prepare trn1.32xlarge for multi-node execution — AWS Neuron Documentation ## How to prepare trn1.32xlarge for multi-node execution[#](#how-to-prepare-trn1-32xlarge-for-multi-node-execution "Permalink to this headline") EFA is a low latency transport that is used for inter-node communication. Multi-node jobs, such as distributed training, requires EFA to be enabled on every participating trn1/trn1n 32xlarge instance. Please note that EFA is currently not available on the smaller instances sizes and they cannot be used for running multi-node jobs. trn1.32xlarge has 8 EFA devices, trn1n.32xlarge has 16 EFA devices. The rest of the document will refer to trn1.32xlarge but everything in the document also applies to trn1n.32xlarge except for the different number of EFA devices. ## Launching an instance[#](#launching-an-instance "Permalink to this headline") Before launching trn1 you need to create a security group that allows EFA traffic between the instances. Follow Step1 here: [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa-start.html#efa-start-security](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa-start.html#efa-start-security) and note the newly created security group ID. It will be used on the next step. Determine the region, the AMI, the key and the subnet that will be used to launch trn1. At the moment launching Trn1 instances with EFA support from the console is not recommended. The instances must be launched using AWS CLI. To launch trn1.32xlarge instance: ``` export AMI=<ami> export SUBNET=<subnet id> export SG=<security group created on the previous step> export REG=<AWS region> export KEY=<the key> aws ec2 run-instances --region ${REG} \ --image-id ${AMI} --instance-type trn1.32xlarge \ --key-name ${KEY} \ --tag-specifications "ResourceType=instance,Tags=[{Key=Name,Value=\"friendly name\"}]" \ --network-interfaces \ "NetworkCardIndex=0,DeviceIndex=0,Groups=${SG},SubnetId=${SUBNET},InterfaceType=efa" \ "NetworkCardIndex=1,DeviceIndex=1,Groups=${SG},SubnetId=${SUBNET},InterfaceType=efa" \ "NetworkCardIndex=2,DeviceIndex=1,Groups=${SG},SubnetId=${SUBNET},InterfaceType=efa" \ "NetworkCardIndex=3,DeviceIndex=1,Groups=${SG},SubnetId=${SUBNET},InterfaceType=efa" \ "NetworkCardIndex=4,DeviceIndex=1,Groups=${SG},SubnetId=${SUBNET},InterfaceType=efa" \ "NetworkCardIndex=5,DeviceIndex=1,Groups=${SG},SubnetId=${SUBNET},InterfaceType=efa" \ "NetworkCardIndex=6,DeviceIndex=1,Groups=${SG},SubnetId=${SUBNET},InterfaceType=efa" \ "NetworkCardIndex=7,DeviceIndex=1,Groups=${SG},SubnetId=${SUBNET},InterfaceType=efa" ``` Note that one of the cards is assigned DeviceIndex 0 and the rest are assigned DeviceIndex 1. Cloud-init will configure instance routing to route outgoing traffic prioritized by the device index field. I.e the outbound traffic will always egress from the interface with DeviceIndex 0. That avoids network connectivity problems when multiple interfaces are attached to the same subnet. To launch trn1n.32xlarge instance: ``` export AMI=<ami> export SUBNET=<subnet id> export SG=<security group created on the previous step> export REG=<AWS region> export KEY=<the key> aws ec2 run-instances --region ${REG} \ --image-id ${AMI} --instance-type trn1.32xlarge \ --key-name ${KEY} \ --tag-specifications "ResourceType=instance,Tags=[{Key=Name,Value=\"friendly name\"}]" \ --network-interfaces \ NetworkCardIndex=0,DeviceIndex=0,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=1,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=2,DeviceIndex=2,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=3,DeviceIndex=3,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=4,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=5,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=6,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=7,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=8,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=9,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=10,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=11,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=12,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=13,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=14,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa \ NetworkCardIndex=15,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa ``` ## Assigning public IP address[#](#assigning-public-ip-address "Permalink to this headline") Multi-interface instances are not assigned public IP automatically. If you require access to the newly launched trn1 from the Internet you need to assign Elastic IP to the interface with DeviceIndex = 0. To find the right interface either parse the output of the instance launch command or use describe-instances command: ``` $ aws ec2 describe-instances --instance-ids i-01b17afa1e6021d6c { "Reservations": [ { "Groups": [], "Instances": [ { "AmiLaunchIndex": 0, "ImageId": "ami-01257e71ecb2f431c", "InstanceId": "i-01b17afa1e6021d6c", "InstanceType": "trn1.32xlarge", ......... "NetworkInterfaces": [ { "Attachment": { "AttachTime": "2023-05-19T17:37:26.000Z", "AttachmentId": "eni-attach-03730388baedd4b96", "DeleteOnTermination": true, "DeviceIndex": 0, "Status": "attached", "NetworkCardIndex": 4 }, "Description": "", ......... "InterfaceType": "efa" }, { "Attachment": { "AttachTime": "2023-05-19T17:37:26.000Z", "AttachmentId": "eni-attach-0e1242371cd2532df", "DeleteOnTermination": true, "DeviceIndex": 0, "Status": "attached", "NetworkCardIndex": 3 }, "Description": "", ................ } ] } ``` The second entry in “NetworkInterfaces” in this example has “DeviceIndex” 0 and should be used to attach EIP. ## Software installation[#](#software-installation "Permalink to this headline") The software required for EFA operation is distributed via aws-efa-installer package. The package is preinstalled on Neuron DLAMI. If you’d like to install the latest or if you are using your own AMI follow these steps: ``` curl -O https://efa-installer.amazonaws.com/aws-efa-installer-latest.tar.gz wget https://efa-installer.amazonaws.com/aws-efa-installer.key && gpg --import aws-efa-installer.key cat aws-efa-installer.key | gpg --fingerprint wget https://efa-installer.amazonaws.com/aws-efa-installer-latest.tar.gz.sig && gpg --verify ./aws-efa-installer-latest.tar.gz.sig tar -xvf aws-efa-installer-latest.tar.gz cd aws-efa-installer && sudo bash efa_installer.sh --yes cd sudo rm -rf aws-efa-installer-latest.tar.gz aws-efa-installer ``` ## Containers[#](#containers "Permalink to this headline") aws-efa-installer package must be installed on the instance. That installs both the efa kernel module and the libraries. The libraries must be accessible to an application running inside a container. This can be accomplished by either installing aws-efa-installer package inside the container or by making on the instance library installation path available inside a container. If installing aws-efa-installer package inside a container pass the flag that disables the kernel module installation: ``` sudo bash efa_installer.sh --yes --skip-kmod ``` The location of the libraries is distribution specific: ``` /opt/amazon/efa/lib # Ubuntu /opt/amazon/efa/lib64 # AL2 ``` ## Application execution environment[#](#application-execution-environment "Permalink to this headline") When running an application make sure the following environment variables are set: ``` FI_PROVIDER=efa FI_EFA_USE_DEVICE_RDMA=1 FI_EFA_FORK_SAFE=1 # only required when running on AL2 ``` ## Appendix - trn1 instance launch example script[#](#appendix-trn1-instance-launch-example-script "Permalink to this headline") ``` #!/bin/bash set -e # AWS CLI v2 Installation instructions for Linux: # curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" # unzip awscliv2.zip # sudo ./aws/install # $ aws --version # aws-cli/2.11.20 Python/3.11.3 Linux/5.15.0-1034-aws exe/x86_64.ubuntu.20 prompt/off # Someone with AWS console admin privileges can create an access key ID and secret for this: # Configure credentials: aws configure # Search the AWS AMIs for the most recent "Deep Learning Base Neuron AMI (Ubuntu 20.04) <Latest_Date>" # This one is 2023-05-17 - ami-01257e71ecb2f431c AMI= ... # the ami KEYNAME= ... # your key SG= ... # the security group SUBNET= ... # the subnet REGION=us-west-2 # Launch instances echo "Starting instances..." output=$(aws ec2 --region $REGION run-instances \ --tag-specifications 'ResourceType=instance,Tags=[{Key=Name,Value=_Trainium-Big}]' \ --count 1 \ --image-id $AMI \ --instance-type trn1.32xlarge \ --key-name $KEYNAME \ --network-interfaces "NetworkCardIndex=0,DeviceIndex=0,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa" \ "NetworkCardIndex=1,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa" \ "NetworkCardIndex=2,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa" \ "NetworkCardIndex=3,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa" \ "NetworkCardIndex=4,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa" \ "NetworkCardIndex=5,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa" \ "NetworkCardIndex=6,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa" \ "NetworkCardIndex=7,DeviceIndex=1,Groups=$SG,SubnetId=$SUBNET,InterfaceType=efa") # Parse the output to get the instance IDs instance_ids=$(echo $output | jq -r .Instances[].InstanceId) echo "Got created instance IDs: $instance_ids" # Loop through each instance ID public_ips="" for instance_id in $instance_ids; do echo "Waiting for instance $instance_id to be running..." aws ec2 wait instance-running --instance-ids $instance_id --region $REGION echo "Creating SSH public IP newtork inteface for instance $instance_id..." interface_id="" INSTANCE_INFO=$(aws ec2 describe-instances --region $REGION --instance-ids $instance_id) OUTPUT=$(echo "$INSTANCE_INFO" | jq -r '.Reservations[0].Instances[0].NetworkInterfaces[] | "\(.Attachment.DeviceIndex),\(.NetworkInterfaceId)"') echo $OUTPUT for pair in $OUTPUT; do IFS="," read -r device_idx ni_id <<< $pair if [ "$device_idx" == "0" ]; then interface_id=$ni_id break fi done if [ "$interface_id" == "" ]; then exit -1 fi echo $interface_id echo "Checking for unassociated Elastic IPs..." unassociated_eips=$(aws ec2 describe-addresses --region $REGION | jq -r '.Addresses[] | select(.AssociationId == null) | .AllocationId') if [[ -z "$unassociated_eips" ]]; then echo "No unassociated Elastic IPs found. Allocating new Elastic IP..." eip_output=$(aws ec2 allocate-address --domain vpc --region $REGION) eip_id=$(echo $eip_output | jq -r .AllocationId) echo "Allocated Elastic IP ID: $eip_id" eip_public_ip=$(echo $eip_output | jq -r .PublicIp) echo "Allocated Elastic IP Public IP: $eip_public_ip" echo "Note that this newly allocated Elasic IP will persist even after the instance termination" echo "If the Elastic IP is not going to be reused do not forget to delete it" else # use the first unassociated Elastic IP found eip_id=$(echo "$unassociated_eips" | head -n 1) echo "Found unassociated Elastic IP ID: $eip_id" eip_public_ip=$(aws ec2 describe-addresses --allocation-ids $eip_id --region $REGION | jq -r .Addresses[0].PublicIp) echo "Elastic IP Public IP: $eip_public_ip" fi public_ips+="${eip_public_ip} " echo "Associating Elastic IP with network interface $interface_id..." aws ec2 associate-address --allocation-id $eip_id --network-interface-id $interface_id --region $REGION echo "Associated Elastic IP with network interface." done echo "The instance has been launched.\nYou can now SSH into $public_ips with key $KEYNAME.\n" ``` Note if you face connectivity issues after launching trn1\\trn1n 32xlarge instance on Ubuntu, please follow the troubleshooting instructions mentioned [here.](training-troubleshooting.html#trn1-ubuntu-troubleshooting) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>How to prepare trn1.32xlarge for multi-node execution — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="PyTorch Neuron (torch-neuronx) for Training Troubleshooting Guide" href="training-troubleshooting.html"> <link rel="prev" title="PyTorch Neuron (torch-neuronx) - Supported Operators" href="pytorch-neuron-supported-operators.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="misc-training.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#launching-an-instance"> Launching an instance </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#assigning-public-ip-address"> Assigning public IP address </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#software-installation"> Software installation </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#containers"> Containers </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#application-execution-environment"> Application execution environment </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#appendix-trn1-instance-launch-example-script"> Appendix - trn1 instance launch example script </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>How to prepare trn1.32xlarge for multi-node execution</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#launching-an-instance"> Launching an instance </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#assigning-public-ip-address"> Assigning public IP address </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#software-installation"> Software installation </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#containers"> Containers </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#application-execution-environment"> Application execution environment </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#appendix-trn1-instance-launch-example-script"> Appendix - trn1 instance launch example script </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="how-to-prepare-trn1-32xlarge-for-multi-node-execution"> <span id="setup-trn1-multi-node-execution"></span><h1>How to prepare trn1.32xlarge for multi-node execution<a class="headerlink" href="#how-to-prepare-trn1-32xlarge-for-multi-node-execution" title="Permalink to this headline">#</a></h1> <p>EFA is a low latency transport that is used for inter-node communication. Multi-node jobs, such as distributed training, requires EFA to be enabled on every participating trn1/trn1n 32xlarge instance. Please note that EFA is currently not available on the smaller instances sizes and they cannot be used for running multi-node jobs.</p> <p>trn1.32xlarge has 8 EFA devices, trn1n.32xlarge has 16 EFA devices. The rest of the document will refer to trn1.32xlarge but everything in the document also applies to trn1n.32xlarge except for the different number of EFA devices.</p> <div class="section" id="launching-an-instance"> <h2>Launching an instance<a class="headerlink" href="#launching-an-instance" title="Permalink to this headline">#</a></h2> <p>Before launching trn1 you need to create a security group that allows EFA traffic between the instances. Follow Step1 here: <a class="reference external" href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa-start.html#efa-start-security">https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa-start.html#efa-start-security</a> and note the newly created security group ID. It will be used on the next step.</p> <p>Determine the region, the AMI, the key and the subnet that will be used to launch trn1.</p> <p>At the moment launching Trn1 instances with EFA support from the console is not recommended. The instances must be launched using AWS CLI. To launch trn1.32xlarge instance:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">AMI</span><span class="o">=</span>&lt;ami&gt; <span class="nb">export</span><span class="w"> </span><span class="nv">SUBNET</span><span class="o">=</span>&lt;subnet<span class="w"> </span>id&gt; <span class="nb">export</span><span class="w"> </span><span class="nv">SG</span><span class="o">=</span>&lt;security<span class="w"> </span>group<span class="w"> </span>created<span class="w"> </span>on<span class="w"> </span>the<span class="w"> </span>previous<span class="w"> </span>step&gt; <span class="nb">export</span><span class="w"> </span><span class="nv">REG</span><span class="o">=</span>&lt;AWS<span class="w"> </span>region&gt; <span class="nb">export</span><span class="w"> </span><span class="nv">KEY</span><span class="o">=</span>&lt;the<span class="w"> </span>key&gt; aws<span class="w"> </span>ec2<span class="w"> </span>run-instances<span class="w"> </span>--region<span class="w"> </span><span class="si">${</span><span class="nv">REG</span><span class="si">}</span><span class="w"> </span><span class="se">\</span> --image-id<span class="w"> </span><span class="si">${</span><span class="nv">AMI</span><span class="si">}</span><span class="w"> </span>--instance-type<span class="w"> </span>trn1.32xlarge<span class="w"> </span><span class="se">\</span> --key-name<span class="w"> </span><span class="si">${</span><span class="nv">KEY</span><span class="si">}</span><span class="w"> </span><span class="se">\</span> --tag-specifications<span class="w"> </span><span class="s2">"ResourceType=instance,Tags=[{Key=Name,Value=\"friendly name\"}]"</span><span class="w"> </span><span class="se">\</span> --network-interfaces<span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=0,DeviceIndex=0,Groups=</span><span class="si">${</span><span class="nv">SG</span><span class="si">}</span><span class="s2">,SubnetId=</span><span class="si">${</span><span class="nv">SUBNET</span><span class="si">}</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=1,DeviceIndex=1,Groups=</span><span class="si">${</span><span class="nv">SG</span><span class="si">}</span><span class="s2">,SubnetId=</span><span class="si">${</span><span class="nv">SUBNET</span><span class="si">}</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=2,DeviceIndex=1,Groups=</span><span class="si">${</span><span class="nv">SG</span><span class="si">}</span><span class="s2">,SubnetId=</span><span class="si">${</span><span class="nv">SUBNET</span><span class="si">}</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=3,DeviceIndex=1,Groups=</span><span class="si">${</span><span class="nv">SG</span><span class="si">}</span><span class="s2">,SubnetId=</span><span class="si">${</span><span class="nv">SUBNET</span><span class="si">}</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=4,DeviceIndex=1,Groups=</span><span class="si">${</span><span class="nv">SG</span><span class="si">}</span><span class="s2">,SubnetId=</span><span class="si">${</span><span class="nv">SUBNET</span><span class="si">}</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=5,DeviceIndex=1,Groups=</span><span class="si">${</span><span class="nv">SG</span><span class="si">}</span><span class="s2">,SubnetId=</span><span class="si">${</span><span class="nv">SUBNET</span><span class="si">}</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=6,DeviceIndex=1,Groups=</span><span class="si">${</span><span class="nv">SG</span><span class="si">}</span><span class="s2">,SubnetId=</span><span class="si">${</span><span class="nv">SUBNET</span><span class="si">}</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=7,DeviceIndex=1,Groups=</span><span class="si">${</span><span class="nv">SG</span><span class="si">}</span><span class="s2">,SubnetId=</span><span class="si">${</span><span class="nv">SUBNET</span><span class="si">}</span><span class="s2">,InterfaceType=efa"</span> </pre></div> </div> <p>Note that one of the cards is assigned DeviceIndex 0 and the rest are assigned DeviceIndex 1. Cloud-init will configure instance routing to route outgoing traffic prioritized by the device index field. I.e the outbound traffic will always egress from the interface with DeviceIndex 0. That avoids network connectivity problems when multiple interfaces are attached to the same subnet.</p> <p>To launch trn1n.32xlarge instance:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">AMI</span><span class="o">=</span>&lt;ami&gt; <span class="nb">export</span><span class="w"> </span><span class="nv">SUBNET</span><span class="o">=</span>&lt;subnet<span class="w"> </span>id&gt; <span class="nb">export</span><span class="w"> </span><span class="nv">SG</span><span class="o">=</span>&lt;security<span class="w"> </span>group<span class="w"> </span>created<span class="w"> </span>on<span class="w"> </span>the<span class="w"> </span>previous<span class="w"> </span>step&gt; <span class="nb">export</span><span class="w"> </span><span class="nv">REG</span><span class="o">=</span>&lt;AWS<span class="w"> </span>region&gt; <span class="nb">export</span><span class="w"> </span><span class="nv">KEY</span><span class="o">=</span>&lt;the<span class="w"> </span>key&gt; aws<span class="w"> </span>ec2<span class="w"> </span>run-instances<span class="w"> </span>--region<span class="w"> </span><span class="si">${</span><span class="nv">REG</span><span class="si">}</span><span class="w"> </span><span class="se">\</span> --image-id<span class="w"> </span><span class="si">${</span><span class="nv">AMI</span><span class="si">}</span><span class="w"> </span>--instance-type<span class="w"> </span>trn1.32xlarge<span class="w"> </span><span class="se">\</span> --key-name<span class="w"> </span><span class="si">${</span><span class="nv">KEY</span><span class="si">}</span><span class="w"> </span><span class="se">\</span> --tag-specifications<span class="w"> </span><span class="s2">"ResourceType=instance,Tags=[{Key=Name,Value=\"friendly name\"}]"</span><span class="w"> </span><span class="se">\</span> --network-interfaces<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">0</span>,DeviceIndex<span class="o">=</span><span class="m">0</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">1</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">2</span>,DeviceIndex<span class="o">=</span><span class="m">2</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">3</span>,DeviceIndex<span class="o">=</span><span class="m">3</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">4</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">5</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">6</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">7</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">8</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">9</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">10</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">11</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">12</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">13</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">14</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa<span class="w"> </span><span class="se">\</span> <span class="w"> </span><span class="nv">NetworkCardIndex</span><span class="o">=</span><span class="m">15</span>,DeviceIndex<span class="o">=</span><span class="m">1</span>,Groups<span class="o">=</span><span class="nv">$SG</span>,SubnetId<span class="o">=</span><span class="nv">$SUBNET</span>,InterfaceType<span class="o">=</span>efa </pre></div> </div> </div> <div class="section" id="assigning-public-ip-address"> <h2>Assigning public IP address<a class="headerlink" href="#assigning-public-ip-address" title="Permalink to this headline">#</a></h2> <p>Multi-interface instances are not assigned public IP automatically. If you require access to the newly launched trn1 from the Internet you need to assign Elastic IP to the interface with DeviceIndex = 0. To find the right interface either parse the output of the instance launch command or use describe-instances command:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>aws<span class="w"> </span>ec2<span class="w"> </span>describe-instances<span class="w"> </span>--instance-ids<span class="w"> </span>i-01b17afa1e6021d6c <span class="o">{</span> <span class="w"> </span><span class="s2">"Reservations"</span>:<span class="w"> </span><span class="o">[</span> <span class="w"> </span><span class="o">{</span> <span class="w"> </span><span class="s2">"Groups"</span>:<span class="w"> </span><span class="o">[]</span>, <span class="w"> </span><span class="s2">"Instances"</span>:<span class="w"> </span><span class="o">[</span> <span class="w"> </span><span class="o">{</span> <span class="w"> </span><span class="s2">"AmiLaunchIndex"</span>:<span class="w"> </span><span class="m">0</span>, <span class="w"> </span><span class="s2">"ImageId"</span>:<span class="w"> </span><span class="s2">"ami-01257e71ecb2f431c"</span>, <span class="w"> </span><span class="s2">"InstanceId"</span>:<span class="w"> </span><span class="s2">"i-01b17afa1e6021d6c"</span>, <span class="w"> </span><span class="s2">"InstanceType"</span>:<span class="w"> </span><span class="s2">"trn1.32xlarge"</span>, <span class="w"> </span>......... <span class="w"> </span><span class="s2">"NetworkInterfaces"</span>:<span class="w"> </span><span class="o">[</span> <span class="w"> </span><span class="o">{</span> <span class="w"> </span><span class="s2">"Attachment"</span>:<span class="w"> </span><span class="o">{</span> <span class="w"> </span><span class="s2">"AttachTime"</span>:<span class="w"> </span><span class="s2">"2023-05-19T17:37:26.000Z"</span>, <span class="w"> </span><span class="s2">"AttachmentId"</span>:<span class="w"> </span><span class="s2">"eni-attach-03730388baedd4b96"</span>, <span class="w"> </span><span class="s2">"DeleteOnTermination"</span>:<span class="w"> </span>true, <span class="w"> </span><span class="s2">"DeviceIndex"</span>:<span class="w"> </span><span class="m">0</span>, <span class="w"> </span><span class="s2">"Status"</span>:<span class="w"> </span><span class="s2">"attached"</span>, <span class="w"> </span><span class="s2">"NetworkCardIndex"</span>:<span class="w"> </span><span class="m">4</span> <span class="w"> </span><span class="o">}</span>, <span class="w"> </span><span class="s2">"Description"</span>:<span class="w"> </span><span class="s2">""</span>, <span class="w"> </span>......... <span class="w"> </span><span class="s2">"InterfaceType"</span>:<span class="w"> </span><span class="s2">"efa"</span> <span class="w"> </span><span class="o">}</span>, <span class="w"> </span><span class="o">{</span> <span class="w"> </span><span class="s2">"Attachment"</span>:<span class="w"> </span><span class="o">{</span> <span class="w"> </span><span class="s2">"AttachTime"</span>:<span class="w"> </span><span class="s2">"2023-05-19T17:37:26.000Z"</span>, <span class="w"> </span><span class="s2">"AttachmentId"</span>:<span class="w"> </span><span class="s2">"eni-attach-0e1242371cd2532df"</span>, <span class="w"> </span><span class="s2">"DeleteOnTermination"</span>:<span class="w"> </span>true, <span class="w"> </span><span class="s2">"DeviceIndex"</span>:<span class="w"> </span><span class="m">0</span>, <span class="w"> </span><span class="s2">"Status"</span>:<span class="w"> </span><span class="s2">"attached"</span>, <span class="w"> </span><span class="s2">"NetworkCardIndex"</span>:<span class="w"> </span><span class="m">3</span> <span class="w"> </span><span class="o">}</span>, <span class="w"> </span><span class="s2">"Description"</span>:<span class="w"> </span><span class="s2">""</span>, <span class="w"> </span>................ <span class="w"> </span><span class="o">}</span> <span class="w"> </span><span class="o">]</span> <span class="o">}</span> </pre></div> </div> <p>The second entry in “NetworkInterfaces” in this example has “DeviceIndex” 0 and should be used to attach EIP.</p> </div> <div class="section" id="software-installation"> <h2>Software installation<a class="headerlink" href="#software-installation" title="Permalink to this headline">#</a></h2> <p>The software required for EFA operation is distributed via aws-efa-installer package. The package is preinstalled on Neuron DLAMI. If you’d like to install the latest or if you are using your own AMI follow these steps:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-O<span class="w"> </span>https://efa-installer.amazonaws.com/aws-efa-installer-latest.tar.gz wget<span class="w"> </span>https://efa-installer.amazonaws.com/aws-efa-installer.key<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>gpg<span class="w"> </span>--import<span class="w"> </span>aws-efa-installer.key cat<span class="w"> </span>aws-efa-installer.key<span class="w"> </span><span class="p">|</span><span class="w"> </span>gpg<span class="w"> </span>--fingerprint wget<span class="w"> </span>https://efa-installer.amazonaws.com/aws-efa-installer-latest.tar.gz.sig<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>gpg<span class="w"> </span>--verify<span class="w"> </span>./aws-efa-installer-latest.tar.gz.sig tar<span class="w"> </span>-xvf<span class="w"> </span>aws-efa-installer-latest.tar.gz <span class="nb">cd</span><span class="w"> </span>aws-efa-installer<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>sudo<span class="w"> </span>bash<span class="w"> </span>efa_installer.sh<span class="w"> </span>--yes <span class="nb">cd</span> sudo<span class="w"> </span>rm<span class="w"> </span>-rf<span class="w"> </span>aws-efa-installer-latest.tar.gz<span class="w"> </span>aws-efa-installer </pre></div> </div> </div> <div class="section" id="containers"> <h2>Containers<a class="headerlink" href="#containers" title="Permalink to this headline">#</a></h2> <p>aws-efa-installer package must be installed on the instance. That installs both the efa kernel module and the libraries. The libraries must be accessible to an application running inside a container. This can be accomplished by either installing aws-efa-installer package inside the container or by making on the instance library installation path available inside a container.</p> <p>If installing aws-efa-installer package inside a container pass the flag that disables the kernel module installation:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>bash<span class="w"> </span>efa_installer.sh<span class="w"> </span>--yes<span class="w"> </span>--skip-kmod </pre></div> </div> <p>The location of the libraries is distribution specific:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/opt/amazon/efa/lib<span class="w"> </span><span class="c1"># Ubuntu</span> /opt/amazon/efa/lib64<span class="w"> </span><span class="c1"># AL2</span> </pre></div> </div> </div> <div class="section" id="application-execution-environment"> <h2>Application execution environment<a class="headerlink" href="#application-execution-environment" title="Permalink to this headline">#</a></h2> <p>When running an application make sure the following environment variables are set:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">FI_PROVIDER</span><span class="o">=</span>efa <span class="nv">FI_EFA_USE_DEVICE_RDMA</span><span class="o">=</span><span class="m">1</span> <span class="nv">FI_EFA_FORK_SAFE</span><span class="o">=</span><span class="m">1</span><span class="w"> </span><span class="c1"># only required when running on AL2</span> </pre></div> </div> </div> <div class="section" id="appendix-trn1-instance-launch-example-script"> <h2>Appendix - trn1 instance launch example script<a class="headerlink" href="#appendix-trn1-instance-launch-example-script" title="Permalink to this headline">#</a></h2> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span> <span class="nb">set</span><span class="w"> </span>-e <span class="c1"># AWS CLI v2 Installation instructions for Linux:</span> <span class="c1"># curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"</span> <span class="c1"># unzip awscliv2.zip</span> <span class="c1"># sudo ./aws/install</span> <span class="c1"># $ aws --version</span> <span class="c1"># aws-cli/2.11.20 Python/3.11.3 Linux/5.15.0-1034-aws exe/x86_64.ubuntu.20 prompt/off</span> <span class="c1"># Someone with AWS console admin privileges can create an access key ID and secret for this:</span> <span class="c1"># Configure credentials: aws configure</span> <span class="c1"># Search the AWS AMIs for the most recent "Deep Learning Base Neuron AMI (Ubuntu 20.04) &lt;Latest_Date&gt;"</span> <span class="c1"># This one is 2023-05-17 - ami-01257e71ecb2f431c</span> <span class="nv">AMI</span><span class="o">=</span><span class="w"> </span>...<span class="w"> </span><span class="c1"># the ami</span> <span class="nv">KEYNAME</span><span class="o">=</span><span class="w"> </span>...<span class="w"> </span><span class="c1"># your key</span> <span class="nv">SG</span><span class="o">=</span><span class="w"> </span>...<span class="w"> </span><span class="c1"># the security group</span> <span class="nv">SUBNET</span><span class="o">=</span><span class="w"> </span>...<span class="w"> </span><span class="c1"># the subnet</span> <span class="nv">REGION</span><span class="o">=</span>us-west-2 <span class="c1"># Launch instances</span> <span class="nb">echo</span><span class="w"> </span><span class="s2">"Starting instances..."</span> <span class="nv">output</span><span class="o">=</span><span class="k">$(</span>aws<span class="w"> </span>ec2<span class="w"> </span>--region<span class="w"> </span><span class="nv">$REGION</span><span class="w"> </span>run-instances<span class="w"> </span><span class="se">\</span> --tag-specifications<span class="w"> </span><span class="s1">'ResourceType=instance,Tags=[{Key=Name,Value=_Trainium-Big}]'</span><span class="w"> </span><span class="se">\</span> --count<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="se">\</span> --image-id<span class="w"> </span><span class="nv">$AMI</span><span class="w"> </span><span class="se">\</span> --instance-type<span class="w"> </span>trn1.32xlarge<span class="w"> </span><span class="se">\</span> --key-name<span class="w"> </span><span class="nv">$KEYNAME</span><span class="w"> </span><span class="se">\</span> --network-interfaces<span class="w"> </span><span class="s2">"NetworkCardIndex=0,DeviceIndex=0,Groups=</span><span class="nv">$SG</span><span class="s2">,SubnetId=</span><span class="nv">$SUBNET</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=1,DeviceIndex=1,Groups=</span><span class="nv">$SG</span><span class="s2">,SubnetId=</span><span class="nv">$SUBNET</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=2,DeviceIndex=1,Groups=</span><span class="nv">$SG</span><span class="s2">,SubnetId=</span><span class="nv">$SUBNET</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=3,DeviceIndex=1,Groups=</span><span class="nv">$SG</span><span class="s2">,SubnetId=</span><span class="nv">$SUBNET</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=4,DeviceIndex=1,Groups=</span><span class="nv">$SG</span><span class="s2">,SubnetId=</span><span class="nv">$SUBNET</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=5,DeviceIndex=1,Groups=</span><span class="nv">$SG</span><span class="s2">,SubnetId=</span><span class="nv">$SUBNET</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=6,DeviceIndex=1,Groups=</span><span class="nv">$SG</span><span class="s2">,SubnetId=</span><span class="nv">$SUBNET</span><span class="s2">,InterfaceType=efa"</span><span class="w"> </span><span class="se">\</span> <span class="s2">"NetworkCardIndex=7,DeviceIndex=1,Groups=</span><span class="nv">$SG</span><span class="s2">,SubnetId=</span><span class="nv">$SUBNET</span><span class="s2">,InterfaceType=efa"</span><span class="k">)</span> <span class="c1"># Parse the output to get the instance IDs</span> <span class="nv">instance_ids</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span><span class="w"> </span><span class="nv">$output</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>-r<span class="w"> </span>.Instances<span class="o">[]</span>.InstanceId<span class="k">)</span> <span class="nb">echo</span><span class="w"> </span><span class="s2">"Got created instance IDs: </span><span class="nv">$instance_ids</span><span class="s2">"</span> <span class="c1"># Loop through each instance ID</span> <span class="nv">public_ips</span><span class="o">=</span><span class="s2">""</span> <span class="k">for</span><span class="w"> </span>instance_id<span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="nv">$instance_ids</span><span class="p">;</span><span class="w"> </span><span class="k">do</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Waiting for instance </span><span class="nv">$instance_id</span><span class="s2"> to be running..."</span> <span class="w"> </span>aws<span class="w"> </span>ec2<span class="w"> </span><span class="nb">wait</span><span class="w"> </span>instance-running<span class="w"> </span>--instance-ids<span class="w"> </span><span class="nv">$instance_id</span><span class="w"> </span>--region<span class="w"> </span><span class="nv">$REGION</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Creating SSH public IP newtork inteface for instance </span><span class="nv">$instance_id</span><span class="s2">..."</span> <span class="w"> </span><span class="nv">interface_id</span><span class="o">=</span><span class="s2">""</span> <span class="w"> </span><span class="nv">INSTANCE_INFO</span><span class="o">=</span><span class="k">$(</span>aws<span class="w"> </span>ec2<span class="w"> </span>describe-instances<span class="w"> </span>--region<span class="w"> </span><span class="nv">$REGION</span><span class="w"> </span>--instance-ids<span class="w"> </span><span class="nv">$instance_id</span><span class="k">)</span> <span class="w"> </span><span class="nv">OUTPUT</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span><span class="w"> </span><span class="s2">"</span><span class="nv">$INSTANCE_INFO</span><span class="s2">"</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>-r<span class="w"> </span><span class="s1">'.Reservations[0].Instances[0].NetworkInterfaces[] | "\(.Attachment.DeviceIndex),\(.NetworkInterfaceId)"'</span><span class="k">)</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="nv">$OUTPUT</span> <span class="w"> </span><span class="k">for</span><span class="w"> </span>pair<span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="nv">$OUTPUT</span><span class="p">;</span><span class="w"> </span><span class="k">do</span> <span class="w"> </span><span class="nv">IFS</span><span class="o">=</span><span class="s2">","</span><span class="w"> </span><span class="nb">read</span><span class="w"> </span>-r<span class="w"> </span>device_idx<span class="w"> </span>ni_id<span class="w"> </span><span class="o">&lt;&lt;&lt;</span><span class="w"> </span><span class="nv">$pair</span> <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">[</span><span class="w"> </span><span class="s2">"</span><span class="nv">$device_idx</span><span class="s2">"</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s2">"0"</span><span class="w"> </span><span class="o">]</span><span class="p">;</span><span class="w"> </span><span class="k">then</span> <span class="w"> </span><span class="nv">interface_id</span><span class="o">=</span><span class="nv">$ni_id</span> <span class="w"> </span><span class="k">break</span> <span class="w"> </span><span class="k">fi</span> <span class="w"> </span><span class="k">done</span> <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">[</span><span class="w"> </span><span class="s2">"</span><span class="nv">$interface_id</span><span class="s2">"</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s2">""</span><span class="w"> </span><span class="o">]</span><span class="p">;</span><span class="w"> </span><span class="k">then</span> <span class="w"> </span><span class="nb">exit</span><span class="w"> </span>-1 <span class="w"> </span><span class="k">fi</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="nv">$interface_id</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Checking for unassociated Elastic IPs..."</span> <span class="w"> </span><span class="nv">unassociated_eips</span><span class="o">=</span><span class="k">$(</span>aws<span class="w"> </span>ec2<span class="w"> </span>describe-addresses<span class="w"> </span>--region<span class="w"> </span><span class="nv">$REGION</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>-r<span class="w"> </span><span class="s1">'.Addresses[] | select(.AssociationId == null) | .AllocationId'</span><span class="k">)</span> <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="o">[[</span><span class="w"> </span>-z<span class="w"> </span><span class="s2">"</span><span class="nv">$unassociated_eips</span><span class="s2">"</span><span class="w"> </span><span class="o">]]</span><span class="p">;</span><span class="w"> </span><span class="k">then</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"No unassociated Elastic IPs found. Allocating new Elastic IP..."</span> <span class="w"> </span><span class="nv">eip_output</span><span class="o">=</span><span class="k">$(</span>aws<span class="w"> </span>ec2<span class="w"> </span>allocate-address<span class="w"> </span>--domain<span class="w"> </span>vpc<span class="w"> </span>--region<span class="w"> </span><span class="nv">$REGION</span><span class="k">)</span> <span class="w"> </span><span class="nv">eip_id</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span><span class="w"> </span><span class="nv">$eip_output</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>-r<span class="w"> </span>.AllocationId<span class="k">)</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Allocated Elastic IP ID: </span><span class="nv">$eip_id</span><span class="s2">"</span> <span class="w"> </span><span class="nv">eip_public_ip</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span><span class="w"> </span><span class="nv">$eip_output</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>-r<span class="w"> </span>.PublicIp<span class="k">)</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Allocated Elastic IP Public IP: </span><span class="nv">$eip_public_ip</span><span class="s2">"</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Note that this newly allocated Elasic IP will persist even after the instance termination"</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"If the Elastic IP is not going to be reused do not forget to delete it"</span> <span class="w"> </span><span class="k">else</span> <span class="w"> </span><span class="c1"># use the first unassociated Elastic IP found</span> <span class="w"> </span><span class="nv">eip_id</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span><span class="w"> </span><span class="s2">"</span><span class="nv">$unassociated_eips</span><span class="s2">"</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>head<span class="w"> </span>-n<span class="w"> </span><span class="m">1</span><span class="k">)</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Found unassociated Elastic IP ID: </span><span class="nv">$eip_id</span><span class="s2">"</span> <span class="w"> </span><span class="nv">eip_public_ip</span><span class="o">=</span><span class="k">$(</span>aws<span class="w"> </span>ec2<span class="w"> </span>describe-addresses<span class="w"> </span>--allocation-ids<span class="w"> </span><span class="nv">$eip_id</span><span class="w"> </span>--region<span class="w"> </span><span class="nv">$REGION</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>-r<span class="w"> </span>.Addresses<span class="o">[</span><span class="m">0</span><span class="o">]</span>.PublicIp<span class="k">)</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Elastic IP Public IP: </span><span class="nv">$eip_public_ip</span><span class="s2">"</span> <span class="w"> </span><span class="k">fi</span> <span class="w"> </span><span class="nv">public_ips</span><span class="o">+=</span><span class="s2">"</span><span class="si">${</span><span class="nv">eip_public_ip</span><span class="si">}</span><span class="s2"> "</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Associating Elastic IP with network interface </span><span class="nv">$interface_id</span><span class="s2">..."</span> <span class="w"> </span>aws<span class="w"> </span>ec2<span class="w"> </span>associate-address<span class="w"> </span>--allocation-id<span class="w"> </span><span class="nv">$eip_id</span><span class="w"> </span>--network-interface-id<span class="w"> </span><span class="nv">$interface_id</span><span class="w"> </span>--region<span class="w"> </span><span class="nv">$REGION</span> <span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"Associated Elastic IP with network interface."</span> <span class="k">done</span> <span class="nb">echo</span><span class="w"> </span><span class="s2">"The instance has been launched.\nYou can now SSH into </span><span class="nv">$public_ips</span><span class="s2"> with key </span><span class="nv">$KEYNAME</span><span class="s2">.\n"</span> </pre></div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>if you face connectivity issues after launching trn1\trn1n 32xlarge instance on Ubuntu, please follow the troubleshooting instructions mentioned <a class="reference internal" href="training-troubleshooting.html#trn1-ubuntu-troubleshooting"><span class="std std-ref">here.</span></a></p> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="pytorch-neuron-supported-operators.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) - Supported Operators</p> </div> </a> <a class="right-next" id="next-link" href="training-troubleshooting.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) for Training Troubleshooting Guide</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:11.968Z
PyTorch Neuron (torch-neuronx) for Training Troubleshooting Guide — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/torch/torch-neuronx/training-troubleshooting.html
# PyTorch Neuron (torch-neuronx) for Training Troubleshooting Guide — AWS Neuron Documentation Table of contents - [General Troubleshooting](#general-troubleshooting) - [Possible Error Conditions](#possible-error-conditions) - [Non-Fatal Error OpKernel (‘op: “TPU\*” device\_type: “CPU”’)](#non-fatal-error-opkernel-op-tpu-device-type-cpu) - [XLA runtime error: “Invalid argument: Cannot assign a device for operation”](#xla-runtime-error-invalid-argument-cannot-assign-a-device-for-operation) - [Error: “Could not start gRPC server”](#error-could-not-start-grpc-server) - [Failed compilation result in the cache](#failed-compilation-result-in-the-cache) - [Compilation errors when placing NeuronCache home directory on NFS/EFS/FSx mounted drive](#compilation-errors-when-placing-neuroncache-home-directory-on-nfs-efs-fsx-mounted-drive) - [Compilation error: “Expect ap datatype to be of type float32 float16 bfloat16 uint8”](#compilation-error-expect-ap-datatype-to-be-of-type-float32-float16-bfloat16-uint8) - [NeuronCore(s) not available - Requested:1 Available:0](#neuroncore-s-not-available-requested-1-available-0) - [TDRV error “TDRV:exec\_consume\_infer\_status\_notification”](#tdrv-error-tdrv-exec-consume-infer-status-notification) - [TDRV error “TDRV:tdrv\_one\_tmpbuf\_reserve Number of ONE TMPBUF pages requested exceeded the max number of pages allowed (requested: <N>, max allowed: 16).”](#tdrv-error-tdrv-tdrv-one-tmpbuf-reserve-number-of-one-tmpbuf-pages-requested-exceeded-the-max-number-of-pages-allowed-requested-n-max-allowed-16) - [Could not open the ndX, close device failed, TDRV not initialized](#could-not-open-the-ndx-close-device-failed-tdrv-not-initialized) - [Multiworker execution hangs during NCCL init](#multiworker-execution-hangs-during-nccl-init) - [NRT init error “One or more engines are running. Please restart device by reloading driver”](#nrt-init-error-one-or-more-engines-are-running-please-restart-device-by-reloading-driver) - [NRT error “ERROR TDRV:kbl\_model\_add Attempting to load an incompatible model!”](#nrt-error-error-tdrv-kbl-model-add-attempting-to-load-an-incompatible-model) - [NRT error “ERROR HAL:aws\_hal\_sprot\_config\_remap\_entry SPROT remap destination address must be aligned size”](#nrt-error-error-hal-aws-hal-sprot-config-remap-entry-sprot-remap-destination-address-must-be-aligned-size) - [NCCL warning : “NCCL WARN Timeout waiting for RX (waited 120 sec) - retrying”](#nccl-warning-nccl-warn-timeout-waiting-for-rx-waited-120-sec-retrying) - [RPC error: “RPC failed with status = ‘UNAVAILABLE: Socket closed’”](#rpc-error-rpc-failed-with-status-unavailable-socket-closed) - [Error “Assertion \`listp->slotinfo\[cnt\].gen <= GL(dl\_tls\_generation)’ failed” followed by ‘RPC failed with status = “UNAVAILABLE: Connection reset by peer”’](#error-assertion-listp-slotinfo-cnt-gen-gl-dl-tls-generation-failed-followed-by-rpc-failed-with-status-unavailable-connection-reset-by-peer) - [RPC connection error: “RPC failed with status = UNAVAILABLE: Connection reset by peer” not preceded by any error](#rpc-connection-error-rpc-failed-with-status-unavailable-connection-reset-by-peer-not-preceded-by-any-error) - [Runtime errors “Missing infer\_status notification” followed by “inference timeout”](#runtime-errors-missing-infer-status-notification-followed-by-inference-timeout) - [Protobuf Error “TypeError: Descriptors cannot not be created directly.”](#protobuf-error-typeerror-descriptors-cannot-not-be-created-directly) - [TDRV error “Timestamp program stop timeout”](#tdrv-error-timestamp-program-stop-timeout) - [Compiler error “module ‘numpy’ has no attribute ‘asscalar’”](#compiler-error-module-numpy-has-no-attribute-asscalar) - [Import errors ‘generic\_type: type “IrValue” is already registered!’ or ‘generic\_type: type “XlaBuilder” is already registered!’](#import-errors-generic-type-type-irvalue-is-already-registered-or-generic-type-type-xlabuilder-is-already-registered) - [Import error “import \_XLAC ImportError: <>/site-packages/\_XLAC.cpython-38-x86\_64-linux-gnu.so: undefined symbol”](#import-error-import-xlac-importerror-site-packages-xlac-cpython-38-x86-64-linux-gnu-so-undefined-symbol) - [Network Connectivity Issue on trn1/trn1n 32xlarge with Ubuntu](#network-connectivity-issue-on-trn1-trn1n-32xlarge-with-ubuntu) - [“Too many open files” when running training job](#too-many-open-files-when-running-training-job) This document shows common issues users may encounter while using PyTorch-Neuron and provides guidance how to resolve or work-around them. ## [General Troubleshooting](#id2)[#](#general-troubleshooting "Permalink to this headline") For setting up EFA that is needed for multi-node training, please see [How to prepare trn1.32xlarge for multi-node execution](setup-trn1-multi-node-execution.html#setup-trn1-multi-node-execution) For XLA-related troubleshooting notes see [How to debug models in PyTorch Neuron](programming-guide/training/pytorch-neuron-debug.html#pytorch-neuronx-debug) and [PyTorch-XLA troubleshooting guide](https://github.com/pytorch/xla/blob/master/TROUBLESHOOTING.md). If your multi-worker training run is interrupted, you may need to kill all the python processes (WARNING: this kills all python processes and reload the driver): ``` killall -9 python killall -9 python3 sudo rmmod neuron; sudo modprobe neuron ``` To turn on RT debug: ``` os.environ["NEURON_RT_LOG_LEVEL"] = "INFO" ``` To turn on Neuron NCCL debug: ``` os.environ["NCCL_DEBUG"] = "WARN" os.environ["NCCL_DEBUG_SUBSYS"] = "ALL" ``` If some process crashed during training, you can enable core dumps using `ulimit` command: To see the type of signals that would cause core dumps, see [https://www.man7.org/linux/man-pages/man7/signal.7.html](https://www.man7.org/linux/man-pages/man7/signal.7.html). Note that core dumps take significant amount of storage, so make sure there is enough free disk space before enabling core dumps. On Ubuntu, if Apport is not running, core dump file name is by default “core” in the local directory. To change file location and name format, modify `/proc/sys/kernel/core_pattern` (see [https://www.kernel.org/doc/html/latest/admin-guide/sysctl/kernel.html#core-pattern](https://www.kernel.org/doc/html/latest/admin-guide/sysctl/kernel.html#core-pattern) for pattern info). For example, to dump to /tmp with executable filename and process ID: ``` echo '/tmp/core.%e.%p' | sudo tee /proc/sys/kernel/core_pattern ``` For containers, install appropriate dependencies during docker build (“apt-get update && apt-get -y install build-essential gdb”) and start the container with “–ulimit core=-1” to enable core dump and “-v /tmp/:/tmp/” to ensure core dumps to /tmp are preserved when container is stopped or deleted. Dependencies can also be installed after container is started. On Ubuntu, core dumps can also handled by Apport which is disabled by default. To enable Apport, run `sudo service apport start`. The `/proc/sys/kernel/core_pattern` is updated by Apport service. After a crash, look in /var/log/apport.log for the core dump file name, which should be in located in /var/lib/apport/coredump/. Once you have the core dump, you can use gdb to debug further (for Python applications, <executable> is `python` or `python3`): ``` gdb <executable> <core file> ``` If some process (i.e. XRT server) is killed due to out-of-memory on host (i.e. you see “Out of memory: Killed process <PID>” in syslog or dmesg), there won’t be any core dump generated. However, you can change to it to kernel panic mode to trigger core dump by setting `/proc/sys/vm/panic_on_oom` to value of 1 on the host or from inside container. On the host where you need `sudo` (this change will be reflected inside the container also): ``` echo 1 | sudo tee /proc/sys/vm/panic_on_oom ``` From inside container where `sudo` doesn’t work (this change will be reflected on the host also): ``` echo 1 > /proc/sys/vm/panic_on_oom ``` ## [Possible Error Conditions](#id3)[#](#possible-error-conditions "Permalink to this headline") ### [Non-Fatal Error OpKernel (‘op: “TPU\*” device\_type: “CPU”’)](#id4)[#](#non-fatal-error-opkernel-op-tpu-device-type-cpu "Permalink to this headline") During execution using PyTorch Neuron, you may see these non-fatal error messages: ``` E tensorflow/core/framework/op_kernel.cc:1676] OpKernel ('op: "TPURoundRobin" device_type: "CPU"') for unknown op: TPURoundRobin E tensorflow/core/framework/op_kernel.cc:1676] OpKernel ('op: "TpuHandleToProtoKey" device_type: "CPU"') for unknown op: TpuHandleToProtoKey ``` They don’t affect operation of the PyTorch Neuron and can be ignored. ### [XLA runtime error: “Invalid argument: Cannot assign a device for operation”](#id5)[#](#xla-runtime-error-invalid-argument-cannot-assign-a-device-for-operation "Permalink to this headline") ``` RuntimeError: tensorflow/compiler/xla/xla_client/xrt_computation_client.cc:490 : Check failed: session->session()->Run(session_work->feed_inputs, session_work->outputs_handles, &outputs) == ::tensorflow::Status::OK() (INVALID_ARGUMENT: Cannot assign a device for operation XRTAllocateFromTensor: {{node XRTAllocateFromTensor}} was explicitly assigned to /job:localservice/replica:0/task:0/device:TPU:0 but available devices are [ /job:localservice/replica:0/task:0/device:CPU:0, /job:localservice/replica:0/task:0/device:TPU_SYSTEM:0, /job:localservice/replica:0/task:0/device:XLA_CPU:0 ]. Make sure the device specification refers to a valid device. [[XRTAllocateFromTensor]] vs. OK) *** Begin stack trace *** tensorflow::CurrentStackTrace() xla::util::MultiWait::Complete(std::function<void ()> const&) clone *** End stack trace *** ``` The above error indicates that the framework was not able to initialize the neuron runtime. If you get the above error, check for the following: 1. No other process is taking the neuron cores. If yes, you may have to kill that process. 2. If no process is running, try reloading the driver using `sudo rmmod neuron; sudo modprobe neuron` ### [Error: “Could not start gRPC server”](#id6)[#](#error-could-not-start-grpc-server "Permalink to this headline") If you get “Could not start gRPC server” error, please check if there are any leftover python processes from a previous interrupted run and terminate them before restarting run. ``` E0207 17:22:12.592127280 30834 server_chttp2.cc:40] {"created":"@1644254532.592081429","description":"No address added out of total 1 resolved","file":"external/com_github_grpc_grpc/src/core/ext/t ransport/chttp2/server/chttp2_server.cc","file_line":395,"referenced_errors":[{"created":"@1644254532.592078907","description":"Failed to add any wildcard listeners","file":"external/com_github_grpc_grpc/s rc/core/lib/iomgr/tcp_server_posix.cc","file_line":342,"referenced_errors":[{"created":"@1644254532.592072626","description":"Unable to configure socket","fd":10,"file":"external/com_github_grpc_grpc/src/c ore/lib/iomgr/tcp_server_utils_posix_common.cc","file_line":216,"referenced_errors":[{"created":"@1644254532.592068939","description":"Address already in use","errno":98,"file":"external/com_github_grpc_grpc/src/core/lib/iomgr/tcp_server_utils_posix_common.cc","file_line":189,"os_error":"Address already in use","syscall":"bind"}]},{"created":"@1644254532.592078512","description":"Unable to configure socket" ,"fd":10,"file":"external/com_github_grpc_grpc/src/core/lib/iomgr/tcp_server_utils_posix_common.cc","file_line":216,"referenced_errors":[{"created":"@1644254532.592077123","description":"Address already in use","errno":98,"file":"external/com_github_grpc_grpc/src/core/lib/iomgr/tcp_server_utils_posix_common.cc","file_line":189,"os_error":"Address already in use","syscall":"bind"}]}]}]} 2022-02-07 17:22:12.592170: E tensorflow/core/distributed_runtime/rpc/grpc_server_lib.cc:545] Unknown: Could not start gRPC server ``` ### [Failed compilation result in the cache](#id7)[#](#failed-compilation-result-in-the-cache "Permalink to this headline") All compilation results are by default saved in `Neuron Persistent Cache`. If the Neuron Compiler fails to compile a graph, we save the failed result in the cache. The reason for doing so is, if the user tries to run the same script, we want the users to error out early rather than wait for the compilation to progress and see an error at the later stage. However, there could be certain cases under which a failed compilation may be do you some environment issues. One possible reason of failure could be, during compilation the process went out of memory. This can happen if you are running multiple processes in parallel such that not enough memory is available for compilation of graph. Failure due to such reasons can be easily mitigated by re-running the compilation. In case, you want to retry a failed compilation, you can do that by passing `--retry_failed_compilation` as follows: ``` os.environ['NEURON_CC_FLAGS'] = os.environ.get('NEURON_CC_FLAGS', '') + ' --retry_failed_compilation' ``` This would retry the compilation and would replace a failed result in the cache with a successful compilation result. ### [Compilation errors when placing NeuronCache home directory on NFS/EFS/FSx mounted drive](#id8)[#](#compilation-errors-when-placing-neuroncache-home-directory-on-nfs-efs-fsx-mounted-drive "Permalink to this headline") Currently, NeuronCache default root directory is /var/tmp which is local to the instance you are running on. You can modify the location of the NeuronCache root directory using `NEURON_CC_FLAGS='--cache_dir=<root dir>'`. However, when the NeuronCache directory is placed in a directory that is part of a NFS mounted drive shared among multiple instances, you may encounter file errors such as file not found, file corruption, or KeyError when running multi-instance training: ``` KeyError: 'neff_cache2/neuron-compile-cache/USER_neuroncc-1.0.48875.0+7437fbf18/MODULE_7223055628515330524/MODULE_0_SyncTensorsGraph.14_7223055628515330524_compute1-dy-kaena-training-2-1-e859998e-3035-5df63dab5ce63' ``` This is a result of limitations to file locking on NFS. EFS/FSx also exhibit similar limitation. The workaround is to setup separate NeuronCache root directories for each worker instance, such as ``NEURON_CC_FLAGS="--cache_dir=$HOME/neuron_cache/bert/`hostname`"``, where the home directory is shared among worker instances as in ParallelCluster. Consider the use case of a ParallelCluster with SLURM cluster management. The home directory of the head node is shared via NFS with worker instances. Also, SLURM would terminate the idle worker instances when the cluster is configured as dynamic auto-scaling cluster, and the default cache in the terminated worker instance’s /var/tmp is deleted. So to persist the cache across runs separated by a cluster idle period, we use the workaround above to create separate NeuronCache root directories for each worker instance. For example, see [BERT ParallelCluster script](https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/training/dp_bert_hf_pretrain/run_dp_bert_large_hf_pretrain_bf16_s128.sh#L42). ### [Compilation error: “Expect ap datatype to be of type float32 float16 bfloat16 uint8”](#id9)[#](#compilation-error-expect-ap-datatype-to-be-of-type-float32-float16-bfloat16-uint8 "Permalink to this headline") If an XLA example fails to run because of failed compilation and one of the error messages is “Expect ap datatype to be of type float32 float16 bfloat16 uint8”, then please set the environment variable `XLA_USE_32BIT_LONG=1` in your script: ``` os.environ['XLA_USE_32BIT_LONG'] = '1' ``` ``` 11/18/2021 04:51:25 PM WARNING 34567 [StaticProfiler]: matmul-based transposes inserted by penguin takes up 93.66 percent of all matmul computation terminate called after throwing an instance of 'std::runtime_error' what(): === BIR verification failed === Reason: Expect ap datatype to be of type float32 float16 bfloat16 uint8 Instruction: I-545-0 Opcode: Matmult Input index: 0 Argument AP: Access Pattern: [[1,8],[1,1],[1,1]] Offset: 0 Memory Location: {compare.85-t604_i0}@SB<0,0>(8x2)#Internal DebugInfo: <compare.85||uint16||UNDEF||[8, 1, 1]> ``` ### [NeuronCore(s) not available - Requested:1 Available:0](#id10)[#](#neuroncore-s-not-available-requested-1-available-0 "Permalink to this headline") When you see “NeuronCore(s) not available” please terminate processes that may be holding the NeuronCores and terminate any neuron-top sessions that are running. Also check if someone else is using the system. Then do “sudo rmmod neuron; sudo modprobe neuron” to reload the driver. ``` 2021-Nov-15 15:21:28.0231 7245:7245 ERROR NRT:nrt_allocate_neuron_cores NeuronCore(s) not available - Requested:nc1-nc1 Available:0 2021-11-15 15:21:28.231864: F ./tensorflow/compiler/xla/service/neuron/neuron_runtime.h:1037] Check failed: status == NRT_SUCCESS NEURONPOC : nrt_init failed. Status = 1 ``` Often when you run multi-worker training, there can be many python processes leftover after a run is interrupted. To kill all python processes, run the follow (WARNING: this kills all python processes on the system) then reload the driver: ``` killall -9 python killall -9 python3 sudo rmmod neuron; sudo modprobe neuron ``` ### [TDRV error “TDRV:exec\_consume\_infer\_status\_notification”](#id11)[#](#tdrv-error-tdrv-exec-consume-infer-status-notification "Permalink to this headline") If you see TDRV error “TDRV:exec\_consume\_infer\_status\_notification”, try reloading the driver using `sudo modprobe -r neuron; sudo modprobe neuron;`. ``` 2022-Mar-10 18:51:19.07392022-Mar-10 18:51:19.0739 17821:17931 ERROR TDRV:exec_consume_infer_status_notifications 17822:18046 ERROR TDRV:exec_consume_infer_status_notifications Unexpected number of CC notifications: mod->cc_op_count=1, cc_start_cnt=0, cc_end_cnt=0Unexpected number of CC notifications: mod->cc_op_count=1, cc_start_cnt=0, cc_end_cnt=0 2022-Mar-10 18:51:19.07392022-Mar-10 18:51:19.0739 17821:17931 ERROR TDRV:exec_consume_infer_status_notifications 17822:18046 ERROR TDRV:exec_consume_infer_status_notifications (NON-FATAL, Ignoring) inference timeout (180000 ms) on Neuron Device 0 NC 0, waiting for cc status notifications. (NON-FATAL, Ignoring) inference timeout (180000 ms) on Neuron Device 0 NC 1, waiting for cc status notifications. ``` ### [TDRV error “TDRV:tdrv\_one\_tmpbuf\_reserve Number of ONE TMPBUF pages requested exceeded the max number of pages allowed (requested: <N>, max allowed: 16).”](#id12)[#](#tdrv-error-tdrv-tdrv-one-tmpbuf-reserve-number-of-one-tmpbuf-pages-requested-exceeded-the-max-number-of-pages-allowed-requested-n-max-allowed-16 "Permalink to this headline") If you see the TDRV error “TDRV:tdrv\_one\_tmpbuf\_reserve Number of ONE TMPBUF pages requested exceeded the max number of pages allowed (requested: <N>, max allowed: 16)”, it maybe due to model tensors requiring more device memory then available. A solution is to try training with a smaller data batch size. ``` ERROR TDRV:tdrv_one_tmpbuf_reserve Number of ONE TMPBUF pages requested exceeded the max number of pages allowed (requested: 28, max allowed: 16). ERROR TDRV:copy_and_stage_mr Failed to reserve one tmpbuf memory ERROR TDRV:kbl_model_add copy_and_stage_mr() error W tensorflow/core/distributed_runtime/rpc/grpc_remote_master.cc:157] RPC failed with status = "UNAVAILABLE: Socket closed" and grpc_error_string = "{"created":"@1669183391.155135683","description":"Error received from peer ipv4:172.31.58.24:43941","file":"external/com_github_grpc_grpc/src/core/lib/surface/call.cc","file_line":1056,"grpc_message":"Socket closed","grpc_status":14}", maybe retrying the RPC ``` ### [Could not open the ndX, close device failed, TDRV not initialized](#id13)[#](#could-not-open-the-ndx-close-device-failed-tdrv-not-initialized "Permalink to this headline") If you see error messages stating “Could not open the ndX” (where X is an integer from 0..15), please run `neuron-ls` and ensure that you are able to see all 16 Neuron devices in the output. If one or more devices are missing please report the issue to [[email protected]](mailto:aws-neuron-support%40amazon.com) with the instance ID and a screen capture of `neuron-ls` output. ``` 2021-Nov-11 15:33:20.0161 7912:7912 ERROR TDRV:tdrv_init_mla_phase1 Could not open the nd0 2021-Nov-11 15:33:20.0161 7912:7912 ERROR TDRV:tdrv_destroy_one_mla close device failed 2021-Nov-11 15:33:20.0161 7912:7912 ERROR TDRV:tdrv_destroy TDRV not initialized 2021-Nov-11 15:33:20.0161 7912:7912 ERROR NRT:nrt_init Failed to initialize devices, error:1 2021-11-11 15:33:20.161331: F ./tensorflow/compiler/xla/service/neuron/neuron_runtime.h:1033] Check failed: status == NRT_SUCCESS NEURONPOC : nrt_init failed. Status = 1 ``` ### [Multiworker execution hangs during NCCL init](#id14)[#](#multiworker-execution-hangs-during-nccl-init "Permalink to this headline") When your multi-worker execution hangs during NCCL init, you can try to reserve the port used by environment variable `NEURON_RT_ROOT_COMM_ID` by (here we use host:port localhost:48620 as an example but you can use any free port and root node’s host IP): ``` sudo sysctl -w net.ipv4.ip_local_reserved_ports=48620 ``` Then set the environment variable `NEURON_RT_ROOT_COMM_ID` in your script: ``` os.environ["NEURON_RT_ROOT_COMM_ID"] = "localhost:48620" ``` ### [NRT init error “One or more engines are running. Please restart device by reloading driver”](#id15)[#](#nrt-init-error-one-or-more-engines-are-running-please-restart-device-by-reloading-driver "Permalink to this headline") If you see an error stating “One or more engines are running. Please restart device by reloading driver” please follow the instruction and reload the driver using “`sudo modprobe -r neuron; sudo modprobe neuron;`”. ``` 2021-Nov-15 20:23:27.0280 3793:3793 ERROR TDRV:tpb_eng_init_hals_v2 CRITICAL HW ERROR: One or more engines are running. Please restart device by reloading driver: sudo modprobe -r neuron; sudo modprobe neuron; 2021-Nov-15 20:23:27.0280 3793:3793 ERROR TDRV:tdrv_init_one_mla_phase2 nd0 nc0 HAL init failed. error:1 ``` ### [NRT error “ERROR TDRV:kbl\_model\_add Attempting to load an incompatible model!”](#id16)[#](#nrt-error-error-tdrv-kbl-model-add-attempting-to-load-an-incompatible-model "Permalink to this headline") If you see an NRT error “ERROR TDRV:kbl\_model\_add Attempting to load an incompatible model!” this means that the compiler neuronx-cc used to compile the model is too old. See installation instruction to update to latest compiler. ### [NRT error “ERROR HAL:aws\_hal\_sprot\_config\_remap\_entry SPROT remap destination address must be aligned size”](#id17)[#](#nrt-error-error-hal-aws-hal-sprot-config-remap-entry-sprot-remap-destination-address-must-be-aligned-size "Permalink to this headline") If you see an NRT error “ERROR HAL:aws\_hal\_sprot\_config\_remap\_entry SPROT remap destination address must be aligned size”, please check the kernel version and upgrade it to the distribution’s latest kernel. For example, on Ubuntu 18.04.6 LTS, the kernel version 4.15.0-66-generic is known to cause this error when running MLP tutorial. This is due to a known bug in the kernel in aligned memory allocation. To fix this issue, please upgrade your kernel to latest version (i.e. 4.15.0-171-generic): ``` uname -a sudo apt-get update sudo apt-get upgrade sudo apt-get dist-upgrade ``` Please reboot after the upgrade. Use “uname -a” to check kernel version again after reboot. ### [NCCL warning : “NCCL WARN Timeout waiting for RX (waited 120 sec) - retrying”](#id18)[#](#nccl-warning-nccl-warn-timeout-waiting-for-rx-waited-120-sec-retrying "Permalink to this headline") When running multi-worker training, if a graph has collective communication operator like an `all_reduce`, it requires all the workers involved in the collective communication to load the graph in the runtime at approximately same time. If any of the worker doesn’t load the graph within a 120 sec window from the first model load by any of the worker, you would see warnings like `NCCL WARN Timeout waiting for RX (waited 120 sec) - retrying`. When you see such warnings check for the following in the log messages: 1\. One of the workers is compiling a graph: In multi-worker training, there is a chance that each worker builds a slightly different graph. This would result in cache miss and can result in compilation. Since the compilations during training run are serialized, the first worker can compile and load the graph with collective communication. It would then wait for 120 secs for other works to join. If they don’t show up because they are compiling their own graphs, first worker would start throwing a warning message as above. The warning in this case is `non-fatal` and would go away once all workers have compiled their respective graphs and then loaded them. To identify this scenario, look for `No candidate found under ....` logs around the warning. You should also see `.....` which indicates compilation is in progress. 2\. Server on one of the nodes crashed: In distributed training across multiple nodes, if the server on one node crashed, the workers on other nodes would keep waiting on model load and you would see above `timeout` logs on those nodes. To identify if the server crashed, check if you see the following error on any of the nodes: ``` `RPC failed with status = "UNAVAILABLE: Socket closed" and grpc_error_string = "{"created":"@1664146011.016500243","description":"Error received from peer ipv4:10.1.24.109:37379","file":"external/com_github_grpc_grpc/src/core/lib/surface/call.cc","file_line":1056,"grpc_message":"Socket closed","grpc_status":14}", maybe retrying the RPC` ``` If you see the above error, then it means there is a server crash and you need to cancel the traning run. ### [RPC error: “RPC failed with status = ‘UNAVAILABLE: Socket closed’”](#id19)[#](#rpc-error-rpc-failed-with-status-unavailable-socket-closed "Permalink to this headline") When you see the above error, it means that the xrt server crashed. When you see such an error, look for the following: 1. Check for any error logs before the `RPC error`. That should indicate the root cause of server crash. Note: The actual error log might be buried because of all the `RPC error` logs that swamp the logs. 2. Sometimes the server can crash because of host OOM. This can happen when we are loading and saving checkpoints. In such cases, you only see `RPC errors` and no other log. You can check if any instance is going out of memory by using tools like [dmesg](https://man7.org/linux/man-pages/man1/dmesg.1.html) ### [Error “Assertion \`listp->slotinfo\[cnt\].gen <= GL(dl\_tls\_generation)’ failed” followed by ‘RPC failed with status = “UNAVAILABLE: Connection reset by peer”’](#id20)[#](#error-assertion-listp-slotinfo-cnt-gen-gl-dl-tls-generation-failed-followed-by-rpc-failed-with-status-unavailable-connection-reset-by-peer "Permalink to this headline") The error “Assertion \`listp->slotinfo\[cnt\].gen <= GL(dl\_tls\_generation)’ failed” is intermittent and occurs when using glibc 2.26. To find out the glibc version you have, you can run `ldd --version`. The workaround is to use Ubuntu 20 where glibc is 2.27. ``` INFO: Inconsistency detected by ld.so: ../elf/dl-tls.c: 488: _dl_allocate_tls_init: Assertion `listp->slotinfo[cnt].gen <= GL(dl_tls_generation)' failed! INFO: 2022-10-03 02:16:04.488054: W tensorflow/core/distributed_runtime/rpc/grpc_remote_master.cc:157] RPC failed with status = "UNAVAILABLE: Connection reset by peer" and grpc_error_string = "{"created":"@1664763364.487962663","description":"Error received from peer ipv4:10.0.9.150:41677","file":"external/com_github_grpc_grpc/src/core/lib/surface/call.cc","file_line":1056,"grpc_message":"Connection reset by peer","grpc_status":14}", maybe retrying the RPC ``` ### [RPC connection error: “RPC failed with status = UNAVAILABLE: Connection reset by peer” not preceded by any error](#id21)[#](#rpc-connection-error-rpc-failed-with-status-unavailable-connection-reset-by-peer-not-preceded-by-any-error "Permalink to this headline") This error may not be preceded by another error like shown in the previous section. In this case, the RPC connection error usually happens when we do distributed training across multiple nodes. When you see such error, please wait for a few minutes. It might be because some node is taking time to setup and hence the other node is not able to connect to it just yet. Once, all nodes are up, training should resume. ### [Runtime errors “Missing infer\_status notification” followed by “inference timeout”](#id22)[#](#runtime-errors-missing-infer-status-notification-followed-by-inference-timeout "Permalink to this headline") If you get a timeout error like below: ``` ERROR TDRV:exec_consume_tpb_status_notifications Missing infer_status notification: (end:4) ERROR TDRV:exec_consume_infer_status_notifications (FATAL-RT-UNDEFINED-STATE) inference timeout (600000 ms) on Neuron Device 4 NC 1, waiting for execution completion notification ``` It maybe due to long graph execution time causing synchronization delays exceeding the default timeout. Please try increasing the timeout to larger value using `NEURON_RT_EXEC_TIMEOUT` (unit in seconds) and see if the problem is resolved. ### [Protobuf Error “TypeError: Descriptors cannot not be created directly.”](#id23)[#](#protobuf-error-typeerror-descriptors-cannot-not-be-created-directly "Permalink to this headline") If you install torch-neuronx after neuronx-cc, you may get the Protobuf error “TypeError: Descriptors cannot not be created directly.”. To fix this, please reinstall neuronx-cc using “pip install –force-reinstall neuronx-cc”. ``` Traceback (most recent call last): File "./run_glue.py", line 570, in <module> main() File "./run_glue.py", line 478, in main data_collator=data_collator, File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/transformers/trainer.py", line 399, in __init__ callbacks, self.model, self.tokenizer, self.optimizer, self.lr_scheduler File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/transformers/trainer_callback.py", line 292, in __init__ self.add_callback(cb) File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/transformers/trainer_callback.py", line 309, in add_callback cb = callback() if isinstance(callback, type) else callback File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/transformers/integrations.py", line 390, in __init__ from torch.utils.tensorboard import SummaryWriter # noqa: F401 File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/torch/utils/tensorboard/__init__.py", line 10, in <module> from .writer import FileWriter, SummaryWriter # noqa: F401 File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/torch/utils/tensorboard/writer.py", line 9, in <module> from tensorboard.compat.proto.event_pb2 import SessionLog File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/event_pb2.py", line 17, in <module> from tensorboard.compat.proto import summary_pb2 as tensorboard_dot_compat_dot_proto_dot_summary__pb2 File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/summary_pb2.py", line 17, in <module> from tensorboard.compat.proto import tensor_pb2 as tensorboard_dot_compat_dot_proto_dot_tensor__pb2 File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/tensor_pb2.py", line 16, in <module> from tensorboard.compat.proto import resource_handle_pb2 as tensorboard_dot_compat_dot_proto_dot_resource__handle__pb2 File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/resource_handle_pb2.py", line 16, in <module> from tensorboard.compat.proto import tensor_shape_pb2 as tensorboard_dot_compat_dot_proto_dot_tensor__shape__pb2 File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/tensor_shape_pb2.py", line 42, in <module> serialized_options=None, file=DESCRIPTOR), File "/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/google/protobuf/descriptor.py", line 560, in __new__ _message.Message._CheckCalledFromGeneratedFile() TypeError: Descriptors cannot not be created directly. If this call came from a _pb2.py file, your generated code is out of date and must be regenerated with protoc >= 3.19.0. If you cannot immediately regenerate your protos, some other possible workarounds are: 1. Downgrade the protobuf package to 3.20.x or lower. 2. Set PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python (but this will use pure-Python parsing and will be much slower). ``` ### [TDRV error “Timestamp program stop timeout”](#id24)[#](#tdrv-error-timestamp-program-stop-timeout "Permalink to this headline") If you see TDRV error “Timestamp program stop timeout”, i.e. when rerunning a training script after it was interrupted, try first reloading the driver using `sudo modprobe -r neuron; sudo modprobe neuron;` (make sure neuron-top and/or neuron-monitor are not running). ``` 2022-Aug-31 04:59:21.0546 117717:117717 ERROR TDRV:tsync_wait_eng_stop nd0 nc0 Timestamp program stop timeout (1000 ms) 2022-Aug-31 04:59:21.0546 117717:117717 ERROR TDRV:tsync_wait_nc_stop nd0 nc0 Error while waiting for timestamp program to end on TPB eng 0 2022-Aug-31 04:59:21.0546 117717:117717 ERROR TDRV:tsync_timestamps_finish nd0 nc0 Failed to stop neuron core 2022-Aug-31 04:59:21.0546 117717:117717 ERROR TDRV:tdrv_tsync_timestamps nd0 nc0 Failed to end timestamp sync programs 2022-Aug-31 04:59:22.0768 117717:117717 ERROR TDRV:tdrv_destroy TDRV not initialized 2022-Aug-31 04:59:22.0768 117717:117717 ERROR NRT:nrt_init Failed to initialize devices, error:5 ``` ### [Compiler error “module ‘numpy’ has no attribute ‘asscalar’”](#id25)[#](#compiler-error-module-numpy-has-no-attribute-asscalar "Permalink to this headline") When you have a newer version of numpy in the Python environment, compilations may fail with the “error module ‘numpy’ has no attribute ‘asscalar’”. Please note the neuronx-cc has the following dependency on numpy “numpy<=1.20.0,>=1.13.3”. To workaround this error, please do “pip install –force-reinstall neuronx-cc” to reinstall neuronx-cc with the proper dependencies. ``` ERROR 227874 [neuronx-cc]: *************************************************************** ERROR 227874 [neuronx-cc]: An Internal Compiler Error has occurred ERROR 227874 [neuronx-cc]: *************************************************************** ERROR 227874 [neuronx-cc]: ERROR 227874 [neuronx-cc]: Error message: module 'numpy' has no attribute 'asscalar' ERROR 227874 [neuronx-cc]: ERROR 227874 [neuronx-cc]: Error class: AttributeError ERROR 227874 [neuronx-cc]: Error location: Unknown ERROR 227874 [neuronx-cc]: Version information: ERROR 227874 [neuronx-cc]: NeuronX Compiler version 2.1.0.76+2909d26a2 ERROR 227874 [neuronx-cc]: ERROR 227874 [neuronx-cc]: HWM version 2.1.0.7-64eaede08 ERROR 227874 [neuronx-cc]: NEFF version Dynamic ERROR 227874 [neuronx-cc]: TVM not available ERROR 227874 [neuronx-cc]: NumPy version 1.23.3 ERROR 227874 [neuronx-cc]: MXNet not available ERROR 227874 [neuronx-cc]: ``` ### [Import errors ‘generic\_type: type “IrValue” is already registered!’ or ‘generic\_type: type “XlaBuilder” is already registered!’](#id26)[#](#import-errors-generic-type-type-irvalue-is-already-registered-or-generic-type-type-xlabuilder-is-already-registered "Permalink to this headline") When you encounter a PyTorch import error ‘import \_XLAC … generic\_type: type “IrValue” is already registered!’ or ‘import \_XLAC … generic\_type: type “XlaBuilder” is already registered!’, please check that TensorFlow and/or JAX are not installed in the Python environment. If they are installed, please uninstall them. ### [Import error “import \_XLAC ImportError: <>/site-packages/\_XLAC.cpython-38-x86\_64-linux-gnu.so: undefined symbol”](#id27)[#](#import-error-import-xlac-importerror-site-packages-xlac-cpython-38-x86-64-linux-gnu-so-undefined-symbol "Permalink to this headline") When you encounter a PyTorch import error “import \_XLAC ImportError: <>/site-packages/\_XLAC.cpython-38-x86\_64-linux-gnu.so: undefined symbol” during execution, please check: 1. TensorFlow and/or JAX are not installed in the Python environment. If they are installed, please uninstall them. 2. The installed PyTorch (torch) package major/minor versions match the installed torch-neuronx package’s major/minor versions (ie. 1.11). If they don’t match, please install the version of PyTorch that matches torch-neuronx. ``` Traceback (most recent call last): File "/opt/ml/mlp_train.py", line 11, in <module> import torch_xla.core.xla_model as xm File "/usr/local/lib/python3.8/site-packages/torch_xla/__init__.py", line 117, in <module> import _XLAC ImportError: /usr/local/lib/python3.8/site-packages/_XLAC.cpython-38-x86_64-linux-gnu.so: undefined symbol: _ZNK3c1010TensorImpl7stridesEv ``` #### NaNs seen with transformers version >= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1[#](#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1 "Permalink to this headline") When running HuggingFace BERT (any size) fine-tuning tutorial or pretraining tutorial with transformers version >= 4.21.0 and using XLA\_USE\_BF16=1 or XLA\_DOWNCAST\_BF16=1, you will see NaNs in the loss immediately at the first step. More details on the issue can be found at [pytorch/xla#4152](https://github.com/pytorch/xla/issues/4152). The workaround is to use 4.20.0 or earlier (the tutorials currently recommend version 4.15.0) or add `transformers.modeling_utils.get_parameter_dtype = lambda x: torch.bfloat16` to the Python script. ### [Network Connectivity Issue on trn1/trn1n 32xlarge with Ubuntu](#id28)[#](#network-connectivity-issue-on-trn1-trn1n-32xlarge-with-ubuntu "Permalink to this headline") **Description** Ubuntu distributions have network connectivity issues when multiple interfaces are connected to the same subnet. trn1/trn1n 32xlarge comes with 8/16 network interfaces. (To launch trn1/trn1n with 8/16 interfaces please follow [here](setup-trn1-multi-node-execution.html#setup-trn1-multi-node-execution)) AWS publishes a package that installs a helper service to address the issue. This service runs at the startup, creates the appropriate netplan files, updates the netplan and the the instance networking and terminates. Note that the following fix is only required on instances launched using generic Ubuntu AMIs. Neuron AMIs and instances launched via ParalleCluster do not require the fix. **Patch to fix networking on a multi-interface instance** ``` wget -O /tmp/aws-ubuntu-eni-helper.deb 'https://github.com/aws-samples/aws-efa-nccl-baseami-pipeline/blob/master/nvidia-efa-ami_base/networking/aws-ubuntu-eni-helper_0.3-1_all.deb?raw=true' sudo apt install /tmp/aws-ubuntu-eni-helper.deb -y sudo systemctl enable aws-ubuntu-eni-helper.service sudo systemctl start aws-ubuntu-eni-helper.service ``` **How to apply the patch?** The following steps could be followed to resolve this issue: - Launch trn1.32xl from AWS console (starts with `single interface`, does not suffer from the multi-interface issue) - Apply the patch on this newly launched single-interface instance - Create a new AMI from this instance - Launch an 8 or 16 interface instance using that AMI. Note The patch installs and enables the service but does not run it. This is intentional. The service will run at the startup when the AMI is used to launch a multi-interface instance. **FAQs** Note Neuron DLAMI has the patch installed, users are always encouraged to launch the instances using the DLAMI which does not require any fix. Please refer to the [Set Up Guide](../../../general/setup/index.html#setup-guide-index) to know how to launch an instance using DLAMI. ### [“Too many open files” when running training job](#id29)[#](#too-many-open-files-when-running-training-job "Permalink to this headline") When running a large model training with several workers, it can result in errors like the following. ``` 2023-Jun-14 19:05:29.0312 4112959:4113326 [23] bootstrap.cc:106 CCOM WARN Call to accept failed : Too many open files 2023-Jun-14 19:05:29.0312 4112959:4113263 [14] include/socket.h:438 CCOM WARN Net : Socket creation failed : Too many open files 2023-Jun-14 19:05:29.0312 4112959:4113326 ERROR ENC:ncclBootstrapRecv failed neuronBootstrapRecv request to NCCL 2023-Jun-14 19:05:29.0312 4112959:4113249 [12] bootstrap.cc:106 CCOM WARN Call to accept failed : Too many open files 2023-Jun-14 19:05:29.0312 4112959:4113263 ERROR ENC:ncclBootstrapSend failed neuronBootstrapSend request to NCCL2023-Jun-14 19:05:29.03122023-Jun-14 19:05:29.0312 4112959:4113270 [15] bootstrap.cc:106 CCOM WARN Call to accept failed : Too many open files ``` This can result when the default OS limits is low. The hard and soft limits can be set on OS using the following commands or by manually opening and setting the limits. ``` sudo sed -i 'H;1h;$!d;x;/hard *nofile/!s/$/\n* hard nofile 65536/' /etc/security/limits.conf sudo sed -i 'H;1h;$!d;x;/soft *nofile/!s/$/\n* soft nofile 65536/' /etc/security/limits.conf sudo sed -i 's/^#*\(\*\|\s*\*\)\s*soft\s*nofile\s*[0-9]\+$/\1 soft nofile 65536/' /etc/security/limits.conf sudo sed -i 's/^#*\(\*\|\s*\*\)\s*hard\s*nofile\s*[0-9]\+$/\1 hard nofile 65536/' /etc/security/limits.conf sudo sed -i 's/^#*\(\*\|\s*\*\)\s*soft\s*nofile\s*[0-9]\+$/\1 soft nofile 65536/' /etc/security/limits.d/01_efa.conf || true sudo sed -i 's/^#*\(\*\|\s*\*\)\s*hard\s*nofile\s*[0-9]\+$/\1 hard nofile 65536/' /etc/security/limits.d/01_efa.conf || true ``` The 01\_efa.conf file is created as part of the EFA installation and needs to be updated. If EFA driver is not installed the file 01\_efa.conf doesn’t exist and the sed commands will fail with No such file or directory. If there are other files under limits.d with file limits they need to be updated as well. _This document is relevant for_: `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>PyTorch Neuron (torch-neuronx) for Training Troubleshooting Guide — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow Neuron" href="../../tensorflow/index.html"> <link rel="prev" title="How to prepare trn1.32xlarge for multi-node execution" href="setup-trn1-multi-node-execution.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/torch/torch-neuronx/training-troubleshooting", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> PyTorch Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../training-torch-neuronx.html"> Training </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="misc-training.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tensorflow/index.html"> TensorFlow Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/torch/torch-neuronx/training-troubleshooting.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/torch/torch-neuronx/training-troubleshooting.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/torch/torch-neuronx/training-troubleshooting.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#general-troubleshooting"> General Troubleshooting </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#possible-error-conditions"> Possible Error Conditions </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#non-fatal-error-opkernel-op-tpu-device-type-cpu"> Non-Fatal Error OpKernel (‘op: “TPU*” device_type: “CPU”’) </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#xla-runtime-error-invalid-argument-cannot-assign-a-device-for-operation"> XLA runtime error: “Invalid argument: Cannot assign a device for operation” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-could-not-start-grpc-server"> Error: “Could not start gRPC server” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#failed-compilation-result-in-the-cache"> Failed compilation result in the cache </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compilation-errors-when-placing-neuroncache-home-directory-on-nfs-efs-fsx-mounted-drive"> Compilation errors when placing NeuronCache home directory on NFS/EFS/FSx mounted drive </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compilation-error-expect-ap-datatype-to-be-of-type-float32-float16-bfloat16-uint8"> Compilation error: “Expect ap datatype to be of type float32 float16 bfloat16 uint8” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-s-not-available-requested-1-available-0"> NeuronCore(s) not available - Requested:1 Available:0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#tdrv-error-tdrv-exec-consume-infer-status-notification"> TDRV error “TDRV:exec_consume_infer_status_notification” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#tdrv-error-tdrv-tdrv-one-tmpbuf-reserve-number-of-one-tmpbuf-pages-requested-exceeded-the-max-number-of-pages-allowed-requested-n-max-allowed-16"> TDRV error “TDRV:tdrv_one_tmpbuf_reserve Number of ONE TMPBUF pages requested exceeded the max number of pages allowed (requested: &lt;N&gt;, max allowed: 16).” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#could-not-open-the-ndx-close-device-failed-tdrv-not-initialized"> Could not open the ndX, close device failed, TDRV not initialized </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#multiworker-execution-hangs-during-nccl-init"> Multiworker execution hangs during NCCL init </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nrt-init-error-one-or-more-engines-are-running-please-restart-device-by-reloading-driver"> NRT init error “One or more engines are running. Please restart device by reloading driver” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nrt-error-error-tdrv-kbl-model-add-attempting-to-load-an-incompatible-model"> NRT error “ERROR TDRV:kbl_model_add Attempting to load an incompatible model!” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nrt-error-error-hal-aws-hal-sprot-config-remap-entry-sprot-remap-destination-address-must-be-aligned-size"> NRT error “ERROR HAL:aws_hal_sprot_config_remap_entry SPROT remap destination address must be aligned size” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nccl-warning-nccl-warn-timeout-waiting-for-rx-waited-120-sec-retrying"> NCCL warning : “NCCL WARN Timeout waiting for RX (waited 120 sec) - retrying” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#rpc-error-rpc-failed-with-status-unavailable-socket-closed"> RPC error: “RPC failed with status = ‘UNAVAILABLE: Socket closed’” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-assertion-listp-slotinfo-cnt-gen-gl-dl-tls-generation-failed-followed-by-rpc-failed-with-status-unavailable-connection-reset-by-peer"> Error “Assertion `listp-&gt;slotinfo[cnt].gen &lt;= GL(dl_tls_generation)’ failed” followed by ‘RPC failed with status = “UNAVAILABLE: Connection reset by peer”’ </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#rpc-connection-error-rpc-failed-with-status-unavailable-connection-reset-by-peer-not-preceded-by-any-error"> RPC connection error: “RPC failed with status = UNAVAILABLE: Connection reset by peer” not preceded by any error </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#runtime-errors-missing-infer-status-notification-followed-by-inference-timeout"> Runtime errors “Missing infer_status notification” followed by “inference timeout” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#protobuf-error-typeerror-descriptors-cannot-not-be-created-directly"> Protobuf Error “TypeError: Descriptors cannot not be created directly.” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#tdrv-error-timestamp-program-stop-timeout"> TDRV error “Timestamp program stop timeout” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compiler-error-module-numpy-has-no-attribute-asscalar"> Compiler error “module ‘numpy’ has no attribute ‘asscalar’” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#import-errors-generic-type-type-irvalue-is-already-registered-or-generic-type-type-xlabuilder-is-already-registered"> Import errors ‘generic_type: type “IrValue” is already registered!’ or ‘generic_type: type “XlaBuilder” is already registered!’ </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#import-error-import-xlac-importerror-site-packages-xlac-cpython-38-x86-64-linux-gnu-so-undefined-symbol"> Import error “import _XLAC ImportError: &lt;&gt;/site-packages/_XLAC.cpython-38-x86_64-linux-gnu.so: undefined symbol” </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1 </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#network-connectivity-issue-on-trn1-trn1n-32xlarge-with-ubuntu"> Network Connectivity Issue on trn1/trn1n 32xlarge with Ubuntu </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#too-many-open-files-when-running-training-job"> “Too many open files” when running training job </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>PyTorch Neuron (torch-neuronx) for Training Troubleshooting Guide</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#general-troubleshooting"> General Troubleshooting </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#possible-error-conditions"> Possible Error Conditions </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#non-fatal-error-opkernel-op-tpu-device-type-cpu"> Non-Fatal Error OpKernel (‘op: “TPU*” device_type: “CPU”’) </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#xla-runtime-error-invalid-argument-cannot-assign-a-device-for-operation"> XLA runtime error: “Invalid argument: Cannot assign a device for operation” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-could-not-start-grpc-server"> Error: “Could not start gRPC server” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#failed-compilation-result-in-the-cache"> Failed compilation result in the cache </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compilation-errors-when-placing-neuroncache-home-directory-on-nfs-efs-fsx-mounted-drive"> Compilation errors when placing NeuronCache home directory on NFS/EFS/FSx mounted drive </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compilation-error-expect-ap-datatype-to-be-of-type-float32-float16-bfloat16-uint8"> Compilation error: “Expect ap datatype to be of type float32 float16 bfloat16 uint8” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuroncore-s-not-available-requested-1-available-0"> NeuronCore(s) not available - Requested:1 Available:0 </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#tdrv-error-tdrv-exec-consume-infer-status-notification"> TDRV error “TDRV:exec_consume_infer_status_notification” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#tdrv-error-tdrv-tdrv-one-tmpbuf-reserve-number-of-one-tmpbuf-pages-requested-exceeded-the-max-number-of-pages-allowed-requested-n-max-allowed-16"> TDRV error “TDRV:tdrv_one_tmpbuf_reserve Number of ONE TMPBUF pages requested exceeded the max number of pages allowed (requested: &lt;N&gt;, max allowed: 16).” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#could-not-open-the-ndx-close-device-failed-tdrv-not-initialized"> Could not open the ndX, close device failed, TDRV not initialized </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#multiworker-execution-hangs-during-nccl-init"> Multiworker execution hangs during NCCL init </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nrt-init-error-one-or-more-engines-are-running-please-restart-device-by-reloading-driver"> NRT init error “One or more engines are running. Please restart device by reloading driver” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nrt-error-error-tdrv-kbl-model-add-attempting-to-load-an-incompatible-model"> NRT error “ERROR TDRV:kbl_model_add Attempting to load an incompatible model!” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nrt-error-error-hal-aws-hal-sprot-config-remap-entry-sprot-remap-destination-address-must-be-aligned-size"> NRT error “ERROR HAL:aws_hal_sprot_config_remap_entry SPROT remap destination address must be aligned size” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#nccl-warning-nccl-warn-timeout-waiting-for-rx-waited-120-sec-retrying"> NCCL warning : “NCCL WARN Timeout waiting for RX (waited 120 sec) - retrying” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#rpc-error-rpc-failed-with-status-unavailable-socket-closed"> RPC error: “RPC failed with status = ‘UNAVAILABLE: Socket closed’” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#error-assertion-listp-slotinfo-cnt-gen-gl-dl-tls-generation-failed-followed-by-rpc-failed-with-status-unavailable-connection-reset-by-peer"> Error “Assertion `listp-&gt;slotinfo[cnt].gen &lt;= GL(dl_tls_generation)’ failed” followed by ‘RPC failed with status = “UNAVAILABLE: Connection reset by peer”’ </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#rpc-connection-error-rpc-failed-with-status-unavailable-connection-reset-by-peer-not-preceded-by-any-error"> RPC connection error: “RPC failed with status = UNAVAILABLE: Connection reset by peer” not preceded by any error </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#runtime-errors-missing-infer-status-notification-followed-by-inference-timeout"> Runtime errors “Missing infer_status notification” followed by “inference timeout” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#protobuf-error-typeerror-descriptors-cannot-not-be-created-directly"> Protobuf Error “TypeError: Descriptors cannot not be created directly.” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#tdrv-error-timestamp-program-stop-timeout"> TDRV error “Timestamp program stop timeout” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#compiler-error-module-numpy-has-no-attribute-asscalar"> Compiler error “module ‘numpy’ has no attribute ‘asscalar’” </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#import-errors-generic-type-type-irvalue-is-already-registered-or-generic-type-type-xlabuilder-is-already-registered"> Import errors ‘generic_type: type “IrValue” is already registered!’ or ‘generic_type: type “XlaBuilder” is already registered!’ </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#import-error-import-xlac-importerror-site-packages-xlac-cpython-38-x86-64-linux-gnu-so-undefined-symbol"> Import error “import _XLAC ImportError: &lt;&gt;/site-packages/_XLAC.cpython-38-x86_64-linux-gnu.so: undefined symbol” </a> <ul class="nav section-nav flex-column"> <li class="toc-h4 nav-item toc-entry"> <a class="reference internal nav-link" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1 </a> </li> </ul> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#network-connectivity-issue-on-trn1-trn1n-32xlarge-with-ubuntu"> Network Connectivity Issue on trn1/trn1n 32xlarge with Ubuntu </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#too-many-open-files-when-running-training-job"> “Too many open files” when running training job </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="pytorch-neuron-torch-neuronx-for-training-troubleshooting-guide"> <span id="pytorch-neuron-traning-troubleshooting"></span><h1>PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) for Training Troubleshooting Guide<a class="headerlink" href="#pytorch-neuron-torch-neuronx-for-training-troubleshooting-guide" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#general-troubleshooting" id="id2">General Troubleshooting</a></p></li> <li><p><a class="reference internal" href="#possible-error-conditions" id="id3">Possible Error Conditions</a></p> <ul> <li><p><a class="reference internal" href="#non-fatal-error-opkernel-op-tpu-device-type-cpu" id="id4">Non-Fatal Error OpKernel (‘op: “TPU*” device_type: “CPU”’)</a></p></li> <li><p><a class="reference internal" href="#xla-runtime-error-invalid-argument-cannot-assign-a-device-for-operation" id="id5">XLA runtime error: “Invalid argument: Cannot assign a device for operation”</a></p></li> <li><p><a class="reference internal" href="#error-could-not-start-grpc-server" id="id6">Error: “Could not start gRPC server”</a></p></li> <li><p><a class="reference internal" href="#failed-compilation-result-in-the-cache" id="id7">Failed compilation result in the cache</a></p></li> <li><p><a class="reference internal" href="#compilation-errors-when-placing-neuroncache-home-directory-on-nfs-efs-fsx-mounted-drive" id="id8">Compilation errors when placing NeuronCache home directory on NFS/EFS/FSx mounted drive</a></p></li> <li><p><a class="reference internal" href="#compilation-error-expect-ap-datatype-to-be-of-type-float32-float16-bfloat16-uint8" id="id9">Compilation error: “Expect ap datatype to be of type float32 float16 bfloat16 uint8”</a></p></li> <li><p><a class="reference internal" href="#neuroncore-s-not-available-requested-1-available-0" id="id10">NeuronCore(s) not available - Requested:1 Available:0</a></p></li> <li><p><a class="reference internal" href="#tdrv-error-tdrv-exec-consume-infer-status-notification" id="id11">TDRV error “TDRV:exec_consume_infer_status_notification”</a></p></li> <li><p><a class="reference internal" href="#tdrv-error-tdrv-tdrv-one-tmpbuf-reserve-number-of-one-tmpbuf-pages-requested-exceeded-the-max-number-of-pages-allowed-requested-n-max-allowed-16" id="id12">TDRV error “TDRV:tdrv_one_tmpbuf_reserve Number of ONE TMPBUF pages requested exceeded the max number of pages allowed (requested: &lt;N&gt;, max allowed: 16).”</a></p></li> <li><p><a class="reference internal" href="#could-not-open-the-ndx-close-device-failed-tdrv-not-initialized" id="id13">Could not open the ndX, close device failed, TDRV not initialized</a></p></li> <li><p><a class="reference internal" href="#multiworker-execution-hangs-during-nccl-init" id="id14">Multiworker execution hangs during NCCL init</a></p></li> <li><p><a class="reference internal" href="#nrt-init-error-one-or-more-engines-are-running-please-restart-device-by-reloading-driver" id="id15">NRT init error “One or more engines are running. Please restart device by reloading driver”</a></p></li> <li><p><a class="reference internal" href="#nrt-error-error-tdrv-kbl-model-add-attempting-to-load-an-incompatible-model" id="id16">NRT error “ERROR TDRV:kbl_model_add Attempting to load an incompatible model!”</a></p></li> <li><p><a class="reference internal" href="#nrt-error-error-hal-aws-hal-sprot-config-remap-entry-sprot-remap-destination-address-must-be-aligned-size" id="id17">NRT error “ERROR HAL:aws_hal_sprot_config_remap_entry SPROT remap destination address must be aligned size”</a></p></li> <li><p><a class="reference internal" href="#nccl-warning-nccl-warn-timeout-waiting-for-rx-waited-120-sec-retrying" id="id18">NCCL warning : “NCCL WARN Timeout waiting for RX (waited 120 sec) - retrying”</a></p></li> <li><p><a class="reference internal" href="#rpc-error-rpc-failed-with-status-unavailable-socket-closed" id="id19">RPC error: “RPC failed with status = ‘UNAVAILABLE: Socket closed’”</a></p></li> <li><p><a class="reference internal" href="#error-assertion-listp-slotinfo-cnt-gen-gl-dl-tls-generation-failed-followed-by-rpc-failed-with-status-unavailable-connection-reset-by-peer" id="id20">Error “Assertion `listp-&gt;slotinfo[cnt].gen &lt;= GL(dl_tls_generation)’ failed” followed by ‘RPC failed with status = “UNAVAILABLE: Connection reset by peer”’</a></p></li> <li><p><a class="reference internal" href="#rpc-connection-error-rpc-failed-with-status-unavailable-connection-reset-by-peer-not-preceded-by-any-error" id="id21">RPC connection error: “RPC failed with status = UNAVAILABLE: Connection reset by peer” not preceded by any error</a></p></li> <li><p><a class="reference internal" href="#runtime-errors-missing-infer-status-notification-followed-by-inference-timeout" id="id22">Runtime errors “Missing infer_status notification” followed by “inference timeout”</a></p></li> <li><p><a class="reference internal" href="#protobuf-error-typeerror-descriptors-cannot-not-be-created-directly" id="id23">Protobuf Error “TypeError: Descriptors cannot not be created directly.”</a></p></li> <li><p><a class="reference internal" href="#tdrv-error-timestamp-program-stop-timeout" id="id24">TDRV error “Timestamp program stop timeout”</a></p></li> <li><p><a class="reference internal" href="#compiler-error-module-numpy-has-no-attribute-asscalar" id="id25">Compiler error “module ‘numpy’ has no attribute ‘asscalar’”</a></p></li> <li><p><a class="reference internal" href="#import-errors-generic-type-type-irvalue-is-already-registered-or-generic-type-type-xlabuilder-is-already-registered" id="id26">Import errors ‘generic_type: type “IrValue” is already registered!’ or ‘generic_type: type “XlaBuilder” is already registered!’</a></p></li> <li><p><a class="reference internal" href="#import-error-import-xlac-importerror-site-packages-xlac-cpython-38-x86-64-linux-gnu-so-undefined-symbol" id="id27">Import error “import _XLAC ImportError: &lt;&gt;/site-packages/_XLAC.cpython-38-x86_64-linux-gnu.so: undefined symbol”</a></p></li> <li><p><a class="reference internal" href="#network-connectivity-issue-on-trn1-trn1n-32xlarge-with-ubuntu" id="id28">Network Connectivity Issue on trn1/trn1n 32xlarge with Ubuntu</a></p></li> <li><p><a class="reference internal" href="#too-many-open-files-when-running-training-job" id="id29">“Too many open files” when running training job</a></p></li> </ul> </li> </ul> </div> <p>This document shows common issues users may encounter while using PyTorch-Neuron and provides guidance how to resolve or work-around them.</p> <div class="section" id="general-troubleshooting"> <h2><a class="toc-backref" href="#id2">General Troubleshooting</a><a class="headerlink" href="#general-troubleshooting" title="Permalink to this headline">#</a></h2> <p>For setting up EFA that is needed for multi-node training, please see <a class="reference internal" href="setup-trn1-multi-node-execution.html#setup-trn1-multi-node-execution"><span class="std std-ref">How to prepare trn1.32xlarge for multi-node execution</span></a></p> <p>For XLA-related troubleshooting notes see <a class="reference internal" href="programming-guide/training/pytorch-neuron-debug.html#pytorch-neuronx-debug"><span class="std std-ref">How to debug models in PyTorch Neuron</span></a> and <a class="reference external" href="https://github.com/pytorch/xla/blob/master/TROUBLESHOOTING.md">PyTorch-XLA troubleshooting guide</a>.</p> <p>If your multi-worker training run is interrupted, you may need to kill all the python processes (WARNING: this kills all python processes and reload the driver):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>killall<span class="w"> </span>-9<span class="w"> </span>python killall<span class="w"> </span>-9<span class="w"> </span>python3 sudo<span class="w"> </span>rmmod<span class="w"> </span>neuron<span class="p">;</span><span class="w"> </span>sudo<span class="w"> </span>modprobe<span class="w"> </span>neuron </pre></div> </div> <p>To turn on RT debug:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_RT_LOG_LEVEL"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"INFO"</span> </pre></div> </div> <p>To turn on Neuron NCCL debug:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NCCL_DEBUG"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"WARN"</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NCCL_DEBUG_SUBSYS"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"ALL"</span> </pre></div> </div> <p>If some process crashed during training, you can enable core dumps using <code class="docutils literal notranslate"><span class="pre">ulimit</span></code> command:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">ulimit</span><span class="w"> </span>-S<span class="w"> </span>-c<span class="w"> </span>unlimited </pre></div> </div> <p>To see the type of signals that would cause core dumps, see <a class="reference external" href="https://www.man7.org/linux/man-pages/man7/signal.7.html">https://www.man7.org/linux/man-pages/man7/signal.7.html</a>.</p> <p>Note that core dumps take significant amount of storage, so make sure there is enough free disk space before enabling core dumps.</p> <p>On Ubuntu, if Apport is not running, core dump file name is by default “core” in the local directory. To change file location and name format, modify <code class="docutils literal notranslate"><span class="pre">/proc/sys/kernel/core_pattern</span></code> (see <a class="reference external" href="https://www.kernel.org/doc/html/latest/admin-guide/sysctl/kernel.html#core-pattern">https://www.kernel.org/doc/html/latest/admin-guide/sysctl/kernel.html#core-pattern</a> for pattern info). For example, to dump to /tmp with executable filename and process ID:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="s1">'/tmp/core.%e.%p'</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>/proc/sys/kernel/core_pattern </pre></div> </div> <p>For containers, install appropriate dependencies during docker build (“apt-get update &amp;&amp; apt-get -y install build-essential gdb”) and start the container with “–ulimit core=-1” to enable core dump and “-v /tmp/:/tmp/” to ensure core dumps to /tmp are preserved when container is stopped or deleted. Dependencies can also be installed after container is started.</p> <p>On Ubuntu, core dumps can also handled by Apport which is disabled by default. To enable Apport, run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">apport</span> <span class="pre">start</span></code>. The <code class="docutils literal notranslate"><span class="pre">/proc/sys/kernel/core_pattern</span></code> is updated by Apport service. After a crash, look in /var/log/apport.log for the core dump file name, which should be in located in /var/lib/apport/coredump/.</p> <p>Once you have the core dump, you can use gdb to debug further (for Python applications, &lt;executable&gt; is <code class="docutils literal notranslate"><span class="pre">python</span></code> or <code class="docutils literal notranslate"><span class="pre">python3</span></code>):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>gdb<span class="w"> </span>&lt;executable&gt;<span class="w"> </span>&lt;core<span class="w"> </span>file&gt; </pre></div> </div> <p>If some process (i.e. XRT server) is killed due to out-of-memory on host (i.e. you see “Out of memory: Killed process &lt;PID&gt;” in syslog or dmesg), there won’t be any core dump generated. However, you can change to it to kernel panic mode to trigger core dump by setting <code class="docutils literal notranslate"><span class="pre">/proc/sys/vm/panic_on_oom</span></code> to value of 1 on the host or from inside container.</p> <p>On the host where you need <code class="docutils literal notranslate"><span class="pre">sudo</span></code> (this change will be reflected inside the container also):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>/proc/sys/vm/panic_on_oom </pre></div> </div> <p>From inside container where <code class="docutils literal notranslate"><span class="pre">sudo</span></code> doesn’t work (this change will be reflected on the host also):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>&gt;<span class="w"> </span>/proc/sys/vm/panic_on_oom </pre></div> </div> </div> <div class="section" id="possible-error-conditions"> <h2><a class="toc-backref" href="#id3">Possible Error Conditions</a><a class="headerlink" href="#possible-error-conditions" title="Permalink to this headline">#</a></h2> <div class="section" id="non-fatal-error-opkernel-op-tpu-device-type-cpu"> <h3><a class="toc-backref" href="#id4">Non-Fatal Error OpKernel (‘op: “TPU*” device_type: “CPU”’)</a><a class="headerlink" href="#non-fatal-error-opkernel-op-tpu-device-type-cpu" title="Permalink to this headline">#</a></h3> <p>During execution using PyTorch Neuron, you may see these non-fatal error messages:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>E<span class="w"> </span>tensorflow/core/framework/op_kernel.cc:1676<span class="o">]</span><span class="w"> </span>OpKernel<span class="w"> </span><span class="o">(</span><span class="s1">'op: "TPURoundRobin" device_type: "CPU"'</span><span class="o">)</span><span class="w"> </span><span class="k">for</span><span class="w"> </span>unknown<span class="w"> </span>op:<span class="w"> </span>TPURoundRobin E<span class="w"> </span>tensorflow/core/framework/op_kernel.cc:1676<span class="o">]</span><span class="w"> </span>OpKernel<span class="w"> </span><span class="o">(</span><span class="s1">'op: "TpuHandleToProtoKey" device_type: "CPU"'</span><span class="o">)</span><span class="w"> </span><span class="k">for</span><span class="w"> </span>unknown<span class="w"> </span>op:<span class="w"> </span>TpuHandleToProtoKey </pre></div> </div> <p>They don’t affect operation of the PyTorch Neuron and can be ignored.</p> </div> <div class="section" id="xla-runtime-error-invalid-argument-cannot-assign-a-device-for-operation"> <h3><a class="toc-backref" href="#id5">XLA runtime error: “Invalid argument: Cannot assign a device for operation”</a><a class="headerlink" href="#xla-runtime-error-invalid-argument-cannot-assign-a-device-for-operation" title="Permalink to this headline">#</a></h3> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>RuntimeError:<span class="w"> </span>tensorflow/compiler/xla/xla_client/xrt_computation_client.cc:490<span class="w"> </span>:<span class="w"> </span>Check<span class="w"> </span>failed:<span class="w"> </span>session-&gt;session<span class="o">()</span>-&gt;Run<span class="o">(</span>session_work-&gt;feed_inputs,<span class="w"> </span>session_work-&gt;outputs_handles,<span class="w"> </span><span class="p">&amp;</span>outputs<span class="o">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span>::tensorflow::Status::OK<span class="o">()</span><span class="w"> </span><span class="o">(</span>INVALID_ARGUMENT:<span class="w"> </span>Cannot<span class="w"> </span>assign<span class="w"> </span>a<span class="w"> </span>device<span class="w"> </span><span class="k">for</span><span class="w"> </span>operation<span class="w"> </span>XRTAllocateFromTensor:<span class="w"> </span><span class="o">{{</span>node<span class="w"> </span>XRTAllocateFromTensor<span class="o">}}</span><span class="w"> </span>was<span class="w"> </span>explicitly<span class="w"> </span>assigned<span class="w"> </span>to<span class="w"> </span>/job:localservice/replica:0/task:0/device:TPU:0<span class="w"> </span>but<span class="w"> </span>available<span class="w"> </span>devices<span class="w"> </span>are<span class="w"> </span><span class="o">[</span><span class="w"> </span>/job:localservice/replica:0/task:0/device:CPU:0,<span class="w"> </span>/job:localservice/replica:0/task:0/device:TPU_SYSTEM:0,<span class="w"> </span>/job:localservice/replica:0/task:0/device:XLA_CPU:0<span class="w"> </span><span class="o">]</span>.<span class="w"> </span>Make<span class="w"> </span>sure<span class="w"> </span>the<span class="w"> </span>device<span class="w"> </span>specification<span class="w"> </span>refers<span class="w"> </span>to<span class="w"> </span>a<span class="w"> </span>valid<span class="w"> </span>device. <span class="w"> </span><span class="o">[[</span>XRTAllocateFromTensor<span class="o">]]</span><span class="w"> </span>vs.<span class="w"> </span>OK<span class="o">)</span> <span class="w"> </span>***<span class="w"> </span>Begin<span class="w"> </span>stack<span class="w"> </span>trace<span class="w"> </span>*** <span class="w"> </span>tensorflow::CurrentStackTrace<span class="o">()</span> <span class="w"> </span>xla::util::MultiWait::Complete<span class="o">(</span>std::function&lt;void<span class="w"> </span><span class="o">()</span>&gt;<span class="w"> </span>const<span class="p">&amp;</span><span class="o">)</span> <span class="w"> </span>clone <span class="w"> </span>***<span class="w"> </span>End<span class="w"> </span>stack<span class="w"> </span>trace<span class="w"> </span>*** </pre></div> </div> <p>The above error indicates that the framework was not able to initialize the neuron runtime. If you get the above error, check for the following:</p> <ol class="arabic simple"> <li><p>No other process is taking the neuron cores. If yes, you may have to kill that process.</p></li> <li><p>If no process is running, try reloading the driver using <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">rmmod</span> <span class="pre">neuron;</span> <span class="pre">sudo</span> <span class="pre">modprobe</span> <span class="pre">neuron</span></code></p></li> </ol> </div> <div class="section" id="error-could-not-start-grpc-server"> <h3><a class="toc-backref" href="#id6">Error: “Could not start gRPC server”</a><a class="headerlink" href="#error-could-not-start-grpc-server" title="Permalink to this headline">#</a></h3> <p>If you get “Could not start gRPC server” error, please check if there are any leftover python processes from a previous interrupted run and terminate them before restarting run.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>E0207<span class="w"> </span><span class="m">17</span>:22:12.592127280<span class="w"> </span><span class="m">30834</span><span class="w"> </span>server_chttp2.cc:40<span class="o">]</span><span class="w"> </span><span class="o">{</span><span class="s2">"created"</span>:<span class="s2">"@1644254532.592081429"</span>,<span class="s2">"description"</span>:<span class="s2">"No address added out of total 1 resolved"</span>,<span class="s2">"file"</span>:<span class="s2">"external/com_github_grpc_grpc/src/core/ext/t</span> <span class="s2">ransport/chttp2/server/chttp2_server.cc"</span>,<span class="s2">"file_line"</span>:395,<span class="s2">"referenced_errors"</span>:<span class="o">[{</span><span class="s2">"created"</span>:<span class="s2">"@1644254532.592078907"</span>,<span class="s2">"description"</span>:<span class="s2">"Failed to add any wildcard listeners"</span>,<span class="s2">"file"</span>:<span class="s2">"external/com_github_grpc_grpc/s</span> <span class="s2">rc/core/lib/iomgr/tcp_server_posix.cc"</span>,<span class="s2">"file_line"</span>:342,<span class="s2">"referenced_errors"</span>:<span class="o">[{</span><span class="s2">"created"</span>:<span class="s2">"@1644254532.592072626"</span>,<span class="s2">"description"</span>:<span class="s2">"Unable to configure socket"</span>,<span class="s2">"fd"</span>:10,<span class="s2">"file"</span>:<span class="s2">"external/com_github_grpc_grpc/src/c</span> <span class="s2">ore/lib/iomgr/tcp_server_utils_posix_common.cc"</span>,<span class="s2">"file_line"</span>:216,<span class="s2">"referenced_errors"</span>:<span class="o">[{</span><span class="s2">"created"</span>:<span class="s2">"@1644254532.592068939"</span>,<span class="s2">"description"</span>:<span class="s2">"Address already in use"</span>,<span class="s2">"errno"</span>:98,<span class="s2">"file"</span>:<span class="s2">"external/com_github_grpc_grpc/src/core/lib/iomgr/tcp_server_utils_posix_common.cc"</span>,<span class="s2">"file_line"</span>:189,<span class="s2">"os_error"</span>:<span class="s2">"Address already in use"</span>,<span class="s2">"syscall"</span>:<span class="s2">"bind"</span><span class="o">}]}</span>,<span class="o">{</span><span class="s2">"created"</span>:<span class="s2">"@1644254532.592078512"</span>,<span class="s2">"description"</span>:<span class="s2">"Unable to configure socket"</span> ,<span class="s2">"fd"</span>:10,<span class="s2">"file"</span>:<span class="s2">"external/com_github_grpc_grpc/src/core/lib/iomgr/tcp_server_utils_posix_common.cc"</span>,<span class="s2">"file_line"</span>:216,<span class="s2">"referenced_errors"</span>:<span class="o">[{</span><span class="s2">"created"</span>:<span class="s2">"@1644254532.592077123"</span>,<span class="s2">"description"</span>:<span class="s2">"Address already in</span> <span class="s2"> use"</span>,<span class="s2">"errno"</span>:98,<span class="s2">"file"</span>:<span class="s2">"external/com_github_grpc_grpc/src/core/lib/iomgr/tcp_server_utils_posix_common.cc"</span>,<span class="s2">"file_line"</span>:189,<span class="s2">"os_error"</span>:<span class="s2">"Address already in use"</span>,<span class="s2">"syscall"</span>:<span class="s2">"bind"</span><span class="o">}]}]}]}</span> <span class="m">2022</span>-02-07<span class="w"> </span><span class="m">17</span>:22:12.592170:<span class="w"> </span>E<span class="w"> </span>tensorflow/core/distributed_runtime/rpc/grpc_server_lib.cc:545<span class="o">]</span><span class="w"> </span>Unknown:<span class="w"> </span>Could<span class="w"> </span>not<span class="w"> </span>start<span class="w"> </span>gRPC<span class="w"> </span>server </pre></div> </div> </div> <div class="section" id="failed-compilation-result-in-the-cache"> <h3><a class="toc-backref" href="#id7">Failed compilation result in the cache</a><a class="headerlink" href="#failed-compilation-result-in-the-cache" title="Permalink to this headline">#</a></h3> <p>All compilation results are by default saved in <code class="docutils literal notranslate"><span class="pre">Neuron</span> <span class="pre">Persistent</span> <span class="pre">Cache</span></code>. If the Neuron Compiler fails to compile a graph, we save the failed result in the cache. The reason for doing so is, if the user tries to run the same script, we want the users to error out early rather than wait for the compilation to progress and see an error at the later stage. However, there could be certain cases under which a failed compilation may be do you some environment issues. One possible reason of failure could be, during compilation the process went out of memory. This can happen if you are running multiple processes in parallel such that not enough memory is available for compilation of graph. Failure due to such reasons can be easily mitigated by re-running the compilation. In case, you want to retry a failed compilation, you can do that by passing <code class="docutils literal notranslate"><span class="pre">--retry_failed_compilation</span></code> as follows:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">]</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'NEURON_CC_FLAGS'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span> <span class="s1">' --retry_failed_compilation'</span> </pre></div> </div> <p>This would retry the compilation and would replace a failed result in the cache with a successful compilation result.</p> </div> <div class="section" id="compilation-errors-when-placing-neuroncache-home-directory-on-nfs-efs-fsx-mounted-drive"> <h3><a class="toc-backref" href="#id8">Compilation errors when placing NeuronCache home directory on NFS/EFS/FSx mounted drive</a><a class="headerlink" href="#compilation-errors-when-placing-neuroncache-home-directory-on-nfs-efs-fsx-mounted-drive" title="Permalink to this headline">#</a></h3> <p>Currently, NeuronCache default root directory is /var/tmp which is local to the instance you are running on. You can modify the location of the NeuronCache root directory using <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--cache_dir=&lt;root</span> <span class="pre">dir&gt;'</span></code>. However, when the NeuronCache directory is placed in a directory that is part of a NFS mounted drive shared among multiple instances, you may encounter file errors such as file not found, file corruption, or KeyError when running multi-instance training:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>KeyError:<span class="w"> </span><span class="s1">'neff_cache2/neuron-compile-cache/USER_neuroncc-1.0.48875.0+7437fbf18/MODULE_7223055628515330524/MODULE_0_SyncTensorsGraph.14_7223055628515330524_compute1-dy-kaena-training-2-1-e859998e-3035-5df63dab5ce63'</span> </pre></div> </div> <p>This is a result of limitations to file locking on NFS. EFS/FSx also exhibit similar limitation. The workaround is to setup separate NeuronCache root directories for each worker instance, such as <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS="--cache_dir=$HOME/neuron_cache/bert/`hostname`"</span></code>, where the home directory is shared among worker instances as in ParallelCluster.</p> <p>Consider the use case of a ParallelCluster with SLURM cluster management. The home directory of the head node is shared via NFS with worker instances. Also, SLURM would terminate the idle worker instances when the cluster is configured as dynamic auto-scaling cluster, and the default cache in the terminated worker instance’s /var/tmp is deleted. So to persist the cache across runs separated by a cluster idle period, we use the workaround above to create separate NeuronCache root directories for each worker instance. For example, see <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/training/dp_bert_hf_pretrain/run_dp_bert_large_hf_pretrain_bf16_s128.sh#L42">BERT ParallelCluster script</a>.</p> </div> <div class="section" id="compilation-error-expect-ap-datatype-to-be-of-type-float32-float16-bfloat16-uint8"> <h3><a class="toc-backref" href="#id9">Compilation error: “Expect ap datatype to be of type float32 float16 bfloat16 uint8”</a><a class="headerlink" href="#compilation-error-expect-ap-datatype-to-be-of-type-float32-float16-bfloat16-uint8" title="Permalink to this headline">#</a></h3> <p>If an XLA example fails to run because of failed compilation and one of the error messages is “Expect ap datatype to be of type float32 float16 bfloat16 uint8”, then please set the environment variable <code class="docutils literal notranslate"><span class="pre">XLA_USE_32BIT_LONG=1</span></code> in your script:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'XLA_USE_32BIT_LONG'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'1'</span> </pre></div> </div> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">11</span>/18/2021<span class="w"> </span><span class="m">04</span>:51:25<span class="w"> </span>PM<span class="w"> </span>WARNING<span class="w"> </span><span class="m">34567</span><span class="w"> </span><span class="o">[</span>StaticProfiler<span class="o">]</span>:<span class="w"> </span>matmul-based<span class="w"> </span>transposes<span class="w"> </span>inserted<span class="w"> </span>by<span class="w"> </span>penguin<span class="w"> </span>takes<span class="w"> </span>up<span class="w"> </span><span class="m">93</span>.66<span class="w"> </span>percent<span class="w"> </span>of<span class="w"> </span>all<span class="w"> </span>matmul<span class="w"> </span>computation terminate<span class="w"> </span>called<span class="w"> </span>after<span class="w"> </span>throwing<span class="w"> </span>an<span class="w"> </span>instance<span class="w"> </span>of<span class="w"> </span><span class="s1">'std::runtime_error'</span> <span class="w"> </span>what<span class="o">()</span>:<span class="w"> </span><span class="o">===</span><span class="w"> </span>BIR<span class="w"> </span>verification<span class="w"> </span><span class="nv">failed</span><span class="w"> </span><span class="o">===</span> Reason:<span class="w"> </span>Expect<span class="w"> </span>ap<span class="w"> </span>datatype<span class="w"> </span>to<span class="w"> </span>be<span class="w"> </span>of<span class="w"> </span><span class="nb">type</span><span class="w"> </span>float32<span class="w"> </span>float16<span class="w"> </span>bfloat16<span class="w"> </span>uint8 Instruction:<span class="w"> </span>I-545-0 Opcode:<span class="w"> </span>Matmult Input<span class="w"> </span>index:<span class="w"> </span><span class="m">0</span> Argument<span class="w"> </span>AP: Access<span class="w"> </span>Pattern:<span class="w"> </span><span class="o">[[</span><span class="m">1</span>,8<span class="o">]</span>,<span class="o">[</span><span class="m">1</span>,1<span class="o">]</span>,<span class="o">[</span><span class="m">1</span>,1<span class="o">]]</span> Offset:<span class="w"> </span><span class="m">0</span> Memory<span class="w"> </span>Location:<span class="w"> </span><span class="o">{</span>compare.85-t604_i0<span class="o">}</span>@SB&lt;<span class="m">0</span>,0&gt;<span class="o">(</span>8x2<span class="o">)</span><span class="c1">#Internal DebugInfo: &lt;compare.85||uint16||UNDEF||[8, 1, 1]&gt;</span> </pre></div> </div> </div> <div class="section" id="neuroncore-s-not-available-requested-1-available-0"> <h3><a class="toc-backref" href="#id10">NeuronCore(s) not available - Requested:1 Available:0</a><a class="headerlink" href="#neuroncore-s-not-available-requested-1-available-0" title="Permalink to this headline">#</a></h3> <p>When you see “NeuronCore(s) not available” please terminate processes that may be holding the NeuronCores and terminate any neuron-top sessions that are running. Also check if someone else is using the system. Then do “sudo rmmod neuron; sudo modprobe neuron” to reload the driver.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">2021</span>-Nov-15<span class="w"> </span><span class="m">15</span>:21:28.0231<span class="w"> </span><span class="m">7245</span>:7245<span class="w"> </span>ERROR<span class="w"> </span>NRT:nrt_allocate_neuron_cores<span class="w"> </span>NeuronCore<span class="o">(</span>s<span class="o">)</span><span class="w"> </span>not<span class="w"> </span>available<span class="w"> </span>-<span class="w"> </span>Requested:nc1-nc1<span class="w"> </span>Available:0 <span class="m">2021</span>-11-15<span class="w"> </span><span class="m">15</span>:21:28.231864:<span class="w"> </span>F<span class="w"> </span>./tensorflow/compiler/xla/service/neuron/neuron_runtime.h:1037<span class="o">]</span><span class="w"> </span>Check<span class="w"> </span>failed:<span class="w"> </span><span class="nv">status</span><span class="w"> </span><span class="o">==</span><span class="w"> </span>NRT_SUCCESS<span class="w"> </span>NEURONPOC<span class="w"> </span>:<span class="w"> </span>nrt_init<span class="w"> </span>failed.<span class="w"> </span><span class="nv">Status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span> </pre></div> </div> <p>Often when you run multi-worker training, there can be many python processes leftover after a run is interrupted. To kill all python processes, run the follow (WARNING: this kills all python processes on the system) then reload the driver:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>killall<span class="w"> </span>-9<span class="w"> </span>python killall<span class="w"> </span>-9<span class="w"> </span>python3 sudo<span class="w"> </span>rmmod<span class="w"> </span>neuron<span class="p">;</span><span class="w"> </span>sudo<span class="w"> </span>modprobe<span class="w"> </span>neuron </pre></div> </div> </div> <div class="section" id="tdrv-error-tdrv-exec-consume-infer-status-notification"> <h3><a class="toc-backref" href="#id11">TDRV error “TDRV:exec_consume_infer_status_notification”</a><a class="headerlink" href="#tdrv-error-tdrv-exec-consume-infer-status-notification" title="Permalink to this headline">#</a></h3> <p>If you see TDRV error “TDRV:exec_consume_infer_status_notification”, try reloading the driver using <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">modprobe</span> <span class="pre">-r</span> <span class="pre">neuron;</span> <span class="pre">sudo</span> <span class="pre">modprobe</span> <span class="pre">neuron;</span></code>.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">2022</span>-Mar-10<span class="w"> </span><span class="m">18</span>:51:19.07392022-Mar-10<span class="w"> </span><span class="m">18</span>:51:19.0739<span class="w"> </span><span class="m">17821</span>:17931<span class="w"> </span>ERROR<span class="w"> </span>TDRV:exec_consume_infer_status_notifications<span class="w"> </span><span class="m">17822</span>:18046<span class="w"> </span>ERROR<span class="w"> </span>TDRV:exec_consume_infer_status_notifications<span class="w"> </span>Unexpected<span class="w"> </span>number<span class="w"> </span>of<span class="w"> </span>CC<span class="w"> </span>notifications:<span class="w"> </span>mod-&gt;cc_op_count<span class="o">=</span><span class="m">1</span>,<span class="w"> </span><span class="nv">cc_start_cnt</span><span class="o">=</span><span class="m">0</span>,<span class="w"> </span><span class="nv">cc_end_cnt</span><span class="o">=</span>0Unexpected<span class="w"> </span>number<span class="w"> </span>of<span class="w"> </span>CC<span class="w"> </span>notifications:<span class="w"> </span>mod-&gt;cc_op_count<span class="o">=</span><span class="m">1</span>,<span class="w"> </span><span class="nv">cc_start_cnt</span><span class="o">=</span><span class="m">0</span>,<span class="w"> </span><span class="nv">cc_end_cnt</span><span class="o">=</span><span class="m">0</span> <span class="m">2022</span>-Mar-10<span class="w"> </span><span class="m">18</span>:51:19.07392022-Mar-10<span class="w"> </span><span class="m">18</span>:51:19.0739<span class="w"> </span><span class="m">17821</span>:17931<span class="w"> </span>ERROR<span class="w"> </span>TDRV:exec_consume_infer_status_notifications<span class="w"> </span><span class="m">17822</span>:18046<span class="w"> </span>ERROR<span class="w"> </span>TDRV:exec_consume_infer_status_notifications<span class="w"> </span><span class="o">(</span>NON-FATAL,<span class="w"> </span>Ignoring<span class="o">)</span><span class="w"> </span>inference<span class="w"> </span>timeout<span class="w"> </span><span class="o">(</span><span class="m">180000</span><span class="w"> </span>ms<span class="o">)</span><span class="w"> </span>on<span class="w"> </span>Neuron<span class="w"> </span>Device<span class="w"> </span><span class="m">0</span><span class="w"> </span>NC<span class="w"> </span><span class="m">0</span>,<span class="w"> </span>waiting<span class="w"> </span><span class="k">for</span><span class="w"> </span>cc<span class="w"> </span>status<span class="w"> </span>notifications. <span class="o">(</span>NON-FATAL,<span class="w"> </span>Ignoring<span class="o">)</span><span class="w"> </span>inference<span class="w"> </span>timeout<span class="w"> </span><span class="o">(</span><span class="m">180000</span><span class="w"> </span>ms<span class="o">)</span><span class="w"> </span>on<span class="w"> </span>Neuron<span class="w"> </span>Device<span class="w"> </span><span class="m">0</span><span class="w"> </span>NC<span class="w"> </span><span class="m">1</span>,<span class="w"> </span>waiting<span class="w"> </span><span class="k">for</span><span class="w"> </span>cc<span class="w"> </span>status<span class="w"> </span>notifications. </pre></div> </div> </div> <div class="section" id="tdrv-error-tdrv-tdrv-one-tmpbuf-reserve-number-of-one-tmpbuf-pages-requested-exceeded-the-max-number-of-pages-allowed-requested-n-max-allowed-16"> <h3><a class="toc-backref" href="#id12">TDRV error “TDRV:tdrv_one_tmpbuf_reserve Number of ONE TMPBUF pages requested exceeded the max number of pages allowed (requested: &lt;N&gt;, max allowed: 16).”</a><a class="headerlink" href="#tdrv-error-tdrv-tdrv-one-tmpbuf-reserve-number-of-one-tmpbuf-pages-requested-exceeded-the-max-number-of-pages-allowed-requested-n-max-allowed-16" title="Permalink to this headline">#</a></h3> <p>If you see the TDRV error “TDRV:tdrv_one_tmpbuf_reserve Number of ONE TMPBUF pages requested exceeded the max number of pages allowed (requested: &lt;N&gt;, max allowed: 16)”, it maybe due to model tensors requiring more device memory then available. A solution is to try training with a smaller data batch size.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ERROR<span class="w"> </span>TDRV:tdrv_one_tmpbuf_reserve<span class="w"> </span>Number<span class="w"> </span>of<span class="w"> </span>ONE<span class="w"> </span>TMPBUF<span class="w"> </span>pages<span class="w"> </span>requested<span class="w"> </span>exceeded<span class="w"> </span>the<span class="w"> </span>max<span class="w"> </span>number<span class="w"> </span>of<span class="w"> </span>pages<span class="w"> </span>allowed<span class="w"> </span><span class="o">(</span>requested:<span class="w"> </span><span class="m">28</span>,<span class="w"> </span>max<span class="w"> </span>allowed:<span class="w"> </span><span class="m">16</span><span class="o">)</span>. ERROR<span class="w"> </span>TDRV:copy_and_stage_mr<span class="w"> </span>Failed<span class="w"> </span>to<span class="w"> </span>reserve<span class="w"> </span>one<span class="w"> </span>tmpbuf<span class="w"> </span>memory ERROR<span class="w"> </span>TDRV:kbl_model_add<span class="w"> </span>copy_and_stage_mr<span class="o">()</span><span class="w"> </span>error W<span class="w"> </span>tensorflow/core/distributed_runtime/rpc/grpc_remote_master.cc:157<span class="o">]</span><span class="w"> </span>RPC<span class="w"> </span>failed<span class="w"> </span>with<span class="w"> </span><span class="nv">status</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"UNAVAILABLE: Socket closed"</span><span class="w"> </span>and<span class="w"> </span><span class="nv">grpc_error_string</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"{"</span>created<span class="s2">":"</span>@1669183391.155135683<span class="s2">","</span>description<span class="s2">":"</span>Error<span class="w"> </span>received<span class="w"> </span>from<span class="w"> </span>peer<span class="w"> </span>ipv4:172.31.58.24:43941<span class="s2">","</span>file<span class="s2">":"</span>external/com_github_grpc_grpc/src/core/lib/surface/call.cc<span class="s2">","</span>file_line<span class="s2">":1056,"</span>grpc_message<span class="s2">":"</span>Socket<span class="w"> </span>closed<span class="s2">","</span>grpc_status<span class="s2">":14}"</span>,<span class="w"> </span>maybe<span class="w"> </span>retrying<span class="w"> </span>the<span class="w"> </span>RPC </pre></div> </div> </div> <div class="section" id="could-not-open-the-ndx-close-device-failed-tdrv-not-initialized"> <h3><a class="toc-backref" href="#id13">Could not open the ndX, close device failed, TDRV not initialized</a><a class="headerlink" href="#could-not-open-the-ndx-close-device-failed-tdrv-not-initialized" title="Permalink to this headline">#</a></h3> <p>If you see error messages stating “Could not open the ndX” (where X is an integer from 0..15), please run <code class="docutils literal notranslate"><span class="pre">neuron-ls</span></code> and ensure that you are able to see all 16 Neuron devices in the output. If one or more devices are missing please report the issue to <a class="reference external" href="mailto:aws-neuron-support%40amazon.com">aws-neuron-support<span>@</span>amazon<span>.</span>com</a> with the instance ID and a screen capture of <code class="docutils literal notranslate"><span class="pre">neuron-ls</span></code> output.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">2021</span><span class="o">-</span><span class="n">Nov</span><span class="o">-</span><span class="mi">11</span> <span class="mi">15</span><span class="p">:</span><span class="mi">33</span><span class="p">:</span><span class="mf">20.0161</span> <span class="mi">7912</span><span class="p">:</span><span class="mi">7912</span> <span class="n">ERROR</span> <span class="n">TDRV</span><span class="p">:</span><span class="n">tdrv_init_mla_phase1</span> <span class="n">Could</span> <span class="ow">not</span> <span class="nb">open</span> <span class="n">the</span> <span class="n">nd0</span> <span class="mi">2021</span><span class="o">-</span><span class="n">Nov</span><span class="o">-</span><span class="mi">11</span> <span class="mi">15</span><span class="p">:</span><span class="mi">33</span><span class="p">:</span><span class="mf">20.0161</span> <span class="mi">7912</span><span class="p">:</span><span class="mi">7912</span> <span class="n">ERROR</span> <span class="n">TDRV</span><span class="p">:</span><span class="n">tdrv_destroy_one_mla</span> <span class="n">close</span> <span class="n">device</span> <span class="n">failed</span> <span class="mi">2021</span><span class="o">-</span><span class="n">Nov</span><span class="o">-</span><span class="mi">11</span> <span class="mi">15</span><span class="p">:</span><span class="mi">33</span><span class="p">:</span><span class="mf">20.0161</span> <span class="mi">7912</span><span class="p">:</span><span class="mi">7912</span> <span class="n">ERROR</span> <span class="n">TDRV</span><span class="p">:</span><span class="n">tdrv_destroy</span> <span class="n">TDRV</span> <span class="ow">not</span> <span class="n">initialized</span> <span class="mi">2021</span><span class="o">-</span><span class="n">Nov</span><span class="o">-</span><span class="mi">11</span> <span class="mi">15</span><span class="p">:</span><span class="mi">33</span><span class="p">:</span><span class="mf">20.0161</span> <span class="mi">7912</span><span class="p">:</span><span class="mi">7912</span> <span class="n">ERROR</span> <span class="n">NRT</span><span class="p">:</span><span class="n">nrt_init</span> <span class="n">Failed</span> <span class="n">to</span> <span class="n">initialize</span> <span class="n">devices</span><span class="p">,</span> <span class="n">error</span><span class="p">:</span><span class="mi">1</span> <span class="mi">2021</span><span class="o">-</span><span class="mi">11</span><span class="o">-</span><span class="mi">11</span> <span class="mi">15</span><span class="p">:</span><span class="mi">33</span><span class="p">:</span><span class="mf">20.161331</span><span class="p">:</span> <span class="n">F</span> <span class="o">./</span><span class="n">tensorflow</span><span class="o">/</span><span class="n">compiler</span><span class="o">/</span><span class="n">xla</span><span class="o">/</span><span class="n">service</span><span class="o">/</span><span class="n">neuron</span><span class="o">/</span><span class="n">neuron_runtime</span><span class="o">.</span><span class="n">h</span><span class="p">:</span><span class="mi">1033</span><span class="p">]</span> <span class="n">Check</span> <span class="n">failed</span><span class="p">:</span> <span class="n">status</span> <span class="o">==</span> <span class="n">NRT_SUCCESS</span> <span class="n">NEURONPOC</span> <span class="p">:</span> <span class="n">nrt_init</span> <span class="n">failed</span><span class="o">.</span> <span class="n">Status</span> <span class="o">=</span> <span class="mi">1</span> </pre></div> </div> </div> <div class="section" id="multiworker-execution-hangs-during-nccl-init"> <h3><a class="toc-backref" href="#id14">Multiworker execution hangs during NCCL init</a><a class="headerlink" href="#multiworker-execution-hangs-during-nccl-init" title="Permalink to this headline">#</a></h3> <p>When your multi-worker execution hangs during NCCL init, you can try to reserve the port used by environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_RT_ROOT_COMM_ID</span></code> by (here we use host:port localhost:48620 as an example but you can use any free port and root node’s host IP):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>sysctl<span class="w"> </span>-w<span class="w"> </span>net.ipv4.ip_local_reserved_ports<span class="o">=</span><span class="m">48620</span> </pre></div> </div> <p>Then set the environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_RT_ROOT_COMM_ID</span></code> in your script:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">"NEURON_RT_ROOT_COMM_ID"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"localhost:48620"</span> </pre></div> </div> </div> <div class="section" id="nrt-init-error-one-or-more-engines-are-running-please-restart-device-by-reloading-driver"> <span id="id1"></span><h3><a class="toc-backref" href="#id15">NRT init error “One or more engines are running. Please restart device by reloading driver”</a><a class="headerlink" href="#nrt-init-error-one-or-more-engines-are-running-please-restart-device-by-reloading-driver" title="Permalink to this headline">#</a></h3> <p>If you see an error stating “One or more engines are running. Please restart device by reloading driver” please follow the instruction and reload the driver using “<code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">modprobe</span> <span class="pre">-r</span> <span class="pre">neuron;</span> <span class="pre">sudo</span> <span class="pre">modprobe</span> <span class="pre">neuron;</span></code>”.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">2021</span>-Nov-15<span class="w"> </span><span class="m">20</span>:23:27.0280<span class="w"> </span><span class="m">3793</span>:3793<span class="w"> </span>ERROR<span class="w"> </span>TDRV:tpb_eng_init_hals_v2<span class="w"> </span>CRITICAL<span class="w"> </span>HW<span class="w"> </span>ERROR:<span class="w"> </span>One<span class="w"> </span>or<span class="w"> </span>more<span class="w"> </span>engines<span class="w"> </span>are<span class="w"> </span>running.<span class="w"> </span>Please<span class="w"> </span>restart<span class="w"> </span>device<span class="w"> </span>by<span class="w"> </span>reloading<span class="w"> </span>driver: sudo<span class="w"> </span>modprobe<span class="w"> </span>-r<span class="w"> </span>neuron<span class="p">;</span><span class="w"> </span>sudo<span class="w"> </span>modprobe<span class="w"> </span>neuron<span class="p">;</span> <span class="m">2021</span>-Nov-15<span class="w"> </span><span class="m">20</span>:23:27.0280<span class="w"> </span><span class="m">3793</span>:3793<span class="w"> </span>ERROR<span class="w"> </span>TDRV:tdrv_init_one_mla_phase2<span class="w"> </span>nd0<span class="w"> </span>nc0<span class="w"> </span>HAL<span class="w"> </span>init<span class="w"> </span>failed.<span class="w"> </span>error:1 </pre></div> </div> </div> <div class="section" id="nrt-error-error-tdrv-kbl-model-add-attempting-to-load-an-incompatible-model"> <h3><a class="toc-backref" href="#id16">NRT error “ERROR TDRV:kbl_model_add Attempting to load an incompatible model!”</a><a class="headerlink" href="#nrt-error-error-tdrv-kbl-model-add-attempting-to-load-an-incompatible-model" title="Permalink to this headline">#</a></h3> <p>If you see an NRT error “ERROR TDRV:kbl_model_add Attempting to load an incompatible model!” this means that the compiler neuronx-cc used to compile the model is too old. See installation instruction to update to latest compiler.</p> </div> <div class="section" id="nrt-error-error-hal-aws-hal-sprot-config-remap-entry-sprot-remap-destination-address-must-be-aligned-size"> <h3><a class="toc-backref" href="#id17">NRT error “ERROR HAL:aws_hal_sprot_config_remap_entry SPROT remap destination address must be aligned size”</a><a class="headerlink" href="#nrt-error-error-hal-aws-hal-sprot-config-remap-entry-sprot-remap-destination-address-must-be-aligned-size" title="Permalink to this headline">#</a></h3> <p>If you see an NRT error “ERROR HAL:aws_hal_sprot_config_remap_entry SPROT remap destination address must be aligned size”, please check the kernel version and upgrade it to the distribution’s latest kernel.</p> <p>For example, on Ubuntu 18.04.6 LTS, the kernel version 4.15.0-66-generic is known to cause this error when running MLP tutorial. This is due to a known bug in the kernel in aligned memory allocation. To fix this issue, please upgrade your kernel to latest version (i.e. 4.15.0-171-generic):</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>uname<span class="w"> </span>-a sudo<span class="w"> </span>apt-get<span class="w"> </span>update sudo<span class="w"> </span>apt-get<span class="w"> </span>upgrade sudo<span class="w"> </span>apt-get<span class="w"> </span>dist-upgrade </pre></div> </div> <p>Please reboot after the upgrade. Use “uname -a” to check kernel version again after reboot.</p> </div> <div class="section" id="nccl-warning-nccl-warn-timeout-waiting-for-rx-waited-120-sec-retrying"> <h3><a class="toc-backref" href="#id18">NCCL warning : “NCCL WARN Timeout waiting for RX (waited 120 sec) - retrying”</a><a class="headerlink" href="#nccl-warning-nccl-warn-timeout-waiting-for-rx-waited-120-sec-retrying" title="Permalink to this headline">#</a></h3> <p>When running multi-worker training, if a graph has collective communication operator like an <code class="docutils literal notranslate"><span class="pre">all_reduce</span></code>, it requires all the workers involved in the collective communication to load the graph in the runtime at approximately same time. If any of the worker doesn’t load the graph within a 120 sec window from the first model load by any of the worker, you would see warnings like <code class="docutils literal notranslate"><span class="pre">NCCL</span> <span class="pre">WARN</span> <span class="pre">Timeout</span> <span class="pre">waiting</span> <span class="pre">for</span> <span class="pre">RX</span> <span class="pre">(waited</span> <span class="pre">120</span> <span class="pre">sec)</span> <span class="pre">-</span> <span class="pre">retrying</span></code>. When you see such warnings check for the following in the log messages:</p> <p>1. One of the workers is compiling a graph: In multi-worker training, there is a chance that each worker builds a slightly different graph. This would result in cache miss and can result in compilation. Since the compilations during training run are serialized, the first worker can compile and load the graph with collective communication. It would then wait for 120 secs for other works to join. If they don’t show up because they are compiling their own graphs, first worker would start throwing a warning message as above. The warning in this case is <code class="docutils literal notranslate"><span class="pre">non-fatal</span></code> and would go away once all workers have compiled their respective graphs and then loaded them. To identify this scenario, look for <code class="docutils literal notranslate"><span class="pre">No</span> <span class="pre">candidate</span> <span class="pre">found</span> <span class="pre">under</span> <span class="pre">....</span></code> logs around the warning. You should also see <code class="docutils literal notranslate"><span class="pre">.....</span></code> which indicates compilation is in progress.</p> <p>2. Server on one of the nodes crashed: In distributed training across multiple nodes, if the server on one node crashed, the workers on other nodes would keep waiting on model load and you would see above <code class="docutils literal notranslate"><span class="pre">timeout</span></code> logs on those nodes. To identify if the server crashed, check if you see the following error on any of the nodes:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>`RPC failed with status = "UNAVAILABLE: Socket closed" and grpc_error_string = "{"created":"@1664146011.016500243","description":"Error received from peer ipv4:10.1.24.109:37379","file":"external/com_github_grpc_grpc/src/core/lib/surface/call.cc","file_line":1056,"grpc_message":"Socket closed","grpc_status":14}", maybe retrying the RPC` </pre></div> </div> <p>If you see the above error, then it means there is a server crash and you need to cancel the traning run.</p> </div> <div class="section" id="rpc-error-rpc-failed-with-status-unavailable-socket-closed"> <h3><a class="toc-backref" href="#id19">RPC error: “RPC failed with status = ‘UNAVAILABLE: Socket closed’”</a><a class="headerlink" href="#rpc-error-rpc-failed-with-status-unavailable-socket-closed" title="Permalink to this headline">#</a></h3> <p>When you see the above error, it means that the xrt server crashed. When you see such an error, look for the following:</p> <ol class="arabic simple"> <li><p>Check for any error logs before the <code class="docutils literal notranslate"><span class="pre">RPC</span> <span class="pre">error</span></code>. That should indicate the root cause of server crash. Note: The actual error log might be buried because of all the <code class="docutils literal notranslate"><span class="pre">RPC</span> <span class="pre">error</span></code> logs that swamp the logs.</p></li> <li><p>Sometimes the server can crash because of host OOM. This can happen when we are loading and saving checkpoints. In such cases, you only see <code class="docutils literal notranslate"><span class="pre">RPC</span> <span class="pre">errors</span></code> and no other log. You can check if any instance is going out of memory by using tools like <a class="reference external" href="https://man7.org/linux/man-pages/man1/dmesg.1.html">dmesg</a></p></li> </ol> </div> <div class="section" id="error-assertion-listp-slotinfo-cnt-gen-gl-dl-tls-generation-failed-followed-by-rpc-failed-with-status-unavailable-connection-reset-by-peer"> <h3><a class="toc-backref" href="#id20">Error “Assertion `listp-&gt;slotinfo[cnt].gen &lt;= GL(dl_tls_generation)’ failed” followed by ‘RPC failed with status = “UNAVAILABLE: Connection reset by peer”’</a><a class="headerlink" href="#error-assertion-listp-slotinfo-cnt-gen-gl-dl-tls-generation-failed-followed-by-rpc-failed-with-status-unavailable-connection-reset-by-peer" title="Permalink to this headline">#</a></h3> <p>The error “Assertion `listp-&gt;slotinfo[cnt].gen &lt;= GL(dl_tls_generation)’ failed” is intermittent and occurs when using glibc 2.26. To find out the glibc version you have, you can run <code class="docutils literal notranslate"><span class="pre">ldd</span> <span class="pre">--version</span></code>. The workaround is to use Ubuntu 20 where glibc is 2.27.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>INFO: Inconsistency detected by ld.so: ../elf/dl-tls.c: 488: _dl_allocate_tls_init: Assertion `listp-&gt;slotinfo[cnt].gen &lt;= GL(dl_tls_generation)' failed! INFO: 2022-10-03 02:16:04.488054: W tensorflow/core/distributed_runtime/rpc/grpc_remote_master.cc:157] RPC failed with status = "UNAVAILABLE: Connection reset by peer" and grpc_error_string = "{"created":"@1664763364.487962663","description":"Error received from peer ipv4:10.0.9.150:41677","file":"external/com_github_grpc_grpc/src/core/lib/surface/call.cc","file_line":1056,"grpc_message":"Connection reset by peer","grpc_status":14}", maybe retrying the RPC </pre></div> </div> </div> <div class="section" id="rpc-connection-error-rpc-failed-with-status-unavailable-connection-reset-by-peer-not-preceded-by-any-error"> <h3><a class="toc-backref" href="#id21">RPC connection error: “RPC failed with status = UNAVAILABLE: Connection reset by peer” not preceded by any error</a><a class="headerlink" href="#rpc-connection-error-rpc-failed-with-status-unavailable-connection-reset-by-peer-not-preceded-by-any-error" title="Permalink to this headline">#</a></h3> <p>This error may not be preceded by another error like shown in the previous section. In this case, the RPC connection error usually happens when we do distributed training across multiple nodes. When you see such error, please wait for a few minutes. It might be because some node is taking time to setup and hence the other node is not able to connect to it just yet. Once, all nodes are up, training should resume.</p> </div> <div class="section" id="runtime-errors-missing-infer-status-notification-followed-by-inference-timeout"> <h3><a class="toc-backref" href="#id22">Runtime errors “Missing infer_status notification” followed by “inference timeout”</a><a class="headerlink" href="#runtime-errors-missing-infer-status-notification-followed-by-inference-timeout" title="Permalink to this headline">#</a></h3> <p>If you get a timeout error like below:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ERROR<span class="w"> </span>TDRV:exec_consume_tpb_status_notifications<span class="w"> </span>Missing<span class="w"> </span>infer_status<span class="w"> </span>notification:<span class="w"> </span><span class="o">(</span>end:4<span class="o">)</span> ERROR<span class="w"> </span>TDRV:exec_consume_infer_status_notifications<span class="w"> </span><span class="o">(</span>FATAL-RT-UNDEFINED-STATE<span class="o">)</span><span class="w"> </span>inference<span class="w"> </span>timeout<span class="w"> </span><span class="o">(</span><span class="m">600000</span><span class="w"> </span>ms<span class="o">)</span><span class="w"> </span>on<span class="w"> </span>Neuron<span class="w"> </span>Device<span class="w"> </span><span class="m">4</span><span class="w"> </span>NC<span class="w"> </span><span class="m">1</span>,<span class="w"> </span>waiting<span class="w"> </span><span class="k">for</span><span class="w"> </span>execution<span class="w"> </span>completion<span class="w"> </span>notification </pre></div> </div> <p>It maybe due to long graph execution time causing synchronization delays exceeding the default timeout. Please try increasing the timeout to larger value using <code class="docutils literal notranslate"><span class="pre">NEURON_RT_EXEC_TIMEOUT</span></code> (unit in seconds) and see if the problem is resolved.</p> </div> <div class="section" id="protobuf-error-typeerror-descriptors-cannot-not-be-created-directly"> <h3><a class="toc-backref" href="#id23">Protobuf Error “TypeError: Descriptors cannot not be created directly.”</a><a class="headerlink" href="#protobuf-error-typeerror-descriptors-cannot-not-be-created-directly" title="Permalink to this headline">#</a></h3> <p>If you install torch-neuronx after neuronx-cc, you may get the Protobuf error “TypeError: Descriptors cannot not be created directly.”. To fix this, please reinstall neuronx-cc using “pip install –force-reinstall neuronx-cc”.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Traceback<span class="w"> </span><span class="o">(</span>most<span class="w"> </span>recent<span class="w"> </span>call<span class="w"> </span>last<span class="o">)</span>: <span class="w"> </span>File<span class="w"> </span><span class="s2">"./run_glue.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">570</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span>main<span class="o">()</span> <span class="w"> </span>File<span class="w"> </span><span class="s2">"./run_glue.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">478</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>main <span class="w"> </span><span class="nv">data_collator</span><span class="o">=</span>data_collator, <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/transformers/trainer.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">399</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>__init__ <span class="w"> </span>callbacks,<span class="w"> </span>self.model,<span class="w"> </span>self.tokenizer,<span class="w"> </span>self.optimizer,<span class="w"> </span>self.lr_scheduler <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/transformers/trainer_callback.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">292</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>__init__ <span class="w"> </span>self.add_callback<span class="o">(</span>cb<span class="o">)</span> <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/transformers/trainer_callback.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">309</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>add_callback <span class="w"> </span><span class="nv">cb</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>callback<span class="o">()</span><span class="w"> </span><span class="k">if</span><span class="w"> </span>isinstance<span class="o">(</span>callback,<span class="w"> </span><span class="nb">type</span><span class="o">)</span><span class="w"> </span><span class="k">else</span><span class="w"> </span>callback <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/transformers/integrations.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">390</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>__init__ <span class="w"> </span>from<span class="w"> </span>torch.utils.tensorboard<span class="w"> </span>import<span class="w"> </span>SummaryWriter<span class="w"> </span><span class="c1"># noqa: F401</span> <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/torch/utils/tensorboard/__init__.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">10</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span>from<span class="w"> </span>.writer<span class="w"> </span>import<span class="w"> </span>FileWriter,<span class="w"> </span>SummaryWriter<span class="w"> </span><span class="c1"># noqa: F401</span> <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/torch/utils/tensorboard/writer.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">9</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span>from<span class="w"> </span>tensorboard.compat.proto.event_pb2<span class="w"> </span>import<span class="w"> </span>SessionLog <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/event_pb2.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">17</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span>from<span class="w"> </span>tensorboard.compat.proto<span class="w"> </span>import<span class="w"> </span>summary_pb2<span class="w"> </span>as<span class="w"> </span>tensorboard_dot_compat_dot_proto_dot_summary__pb2 <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/summary_pb2.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">17</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span>from<span class="w"> </span>tensorboard.compat.proto<span class="w"> </span>import<span class="w"> </span>tensor_pb2<span class="w"> </span>as<span class="w"> </span>tensorboard_dot_compat_dot_proto_dot_tensor__pb2 <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/tensor_pb2.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">16</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span>from<span class="w"> </span>tensorboard.compat.proto<span class="w"> </span>import<span class="w"> </span>resource_handle_pb2<span class="w"> </span>as<span class="w"> </span>tensorboard_dot_compat_dot_proto_dot_resource__handle__pb2 <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/resource_handle_pb2.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">16</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span>from<span class="w"> </span>tensorboard.compat.proto<span class="w"> </span>import<span class="w"> </span>tensor_shape_pb2<span class="w"> </span>as<span class="w"> </span>tensorboard_dot_compat_dot_proto_dot_tensor__shape__pb2 <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/tensorboard/compat/proto/tensor_shape_pb2.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">42</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span><span class="nv">serialized_options</span><span class="o">=</span>None,<span class="w"> </span><span class="nv">file</span><span class="o">=</span>DESCRIPTOR<span class="o">)</span>, <span class="w"> </span>File<span class="w"> </span><span class="s2">"/home/ec2-user/aws_neuron_venv_pytorch_p37_exp/lib64/python3.7/site-packages/google/protobuf/descriptor.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">560</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>__new__ <span class="w"> </span>_message.Message._CheckCalledFromGeneratedFile<span class="o">()</span> TypeError:<span class="w"> </span>Descriptors<span class="w"> </span>cannot<span class="w"> </span>not<span class="w"> </span>be<span class="w"> </span>created<span class="w"> </span>directly. If<span class="w"> </span>this<span class="w"> </span>call<span class="w"> </span>came<span class="w"> </span>from<span class="w"> </span>a<span class="w"> </span>_pb2.py<span class="w"> </span>file,<span class="w"> </span>your<span class="w"> </span>generated<span class="w"> </span>code<span class="w"> </span>is<span class="w"> </span>out<span class="w"> </span>of<span class="w"> </span>date<span class="w"> </span>and<span class="w"> </span>must<span class="w"> </span>be<span class="w"> </span>regenerated<span class="w"> </span>with<span class="w"> </span>protoc<span class="w"> </span>&gt;<span class="o">=</span><span class="w"> </span><span class="m">3</span>.19.0. If<span class="w"> </span>you<span class="w"> </span>cannot<span class="w"> </span>immediately<span class="w"> </span>regenerate<span class="w"> </span>your<span class="w"> </span>protos,<span class="w"> </span>some<span class="w"> </span>other<span class="w"> </span>possible<span class="w"> </span>workarounds<span class="w"> </span>are: <span class="w"> </span><span class="m">1</span>.<span class="w"> </span>Downgrade<span class="w"> </span>the<span class="w"> </span>protobuf<span class="w"> </span>package<span class="w"> </span>to<span class="w"> </span><span class="m">3</span>.20.x<span class="w"> </span>or<span class="w"> </span>lower. <span class="w"> </span><span class="m">2</span>.<span class="w"> </span>Set<span class="w"> </span><span class="nv">PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION</span><span class="o">=</span>python<span class="w"> </span><span class="o">(</span>but<span class="w"> </span>this<span class="w"> </span>will<span class="w"> </span>use<span class="w"> </span>pure-Python<span class="w"> </span>parsing<span class="w"> </span>and<span class="w"> </span>will<span class="w"> </span>be<span class="w"> </span>much<span class="w"> </span>slower<span class="o">)</span>. </pre></div> </div> </div> <div class="section" id="tdrv-error-timestamp-program-stop-timeout"> <h3><a class="toc-backref" href="#id24">TDRV error “Timestamp program stop timeout”</a><a class="headerlink" href="#tdrv-error-timestamp-program-stop-timeout" title="Permalink to this headline">#</a></h3> <p>If you see TDRV error “Timestamp program stop timeout”, i.e. when rerunning a training script after it was interrupted, try first reloading the driver using <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">modprobe</span> <span class="pre">-r</span> <span class="pre">neuron;</span> <span class="pre">sudo</span> <span class="pre">modprobe</span> <span class="pre">neuron;</span></code> (make sure neuron-top and/or neuron-monitor are not running).</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">2022</span>-Aug-31<span class="w"> </span><span class="m">04</span>:59:21.0546<span class="w"> </span><span class="m">117717</span>:117717<span class="w"> </span>ERROR<span class="w"> </span>TDRV:tsync_wait_eng_stop<span class="w"> </span>nd0<span class="w"> </span>nc0<span class="w"> </span>Timestamp<span class="w"> </span>program<span class="w"> </span>stop<span class="w"> </span>timeout<span class="w"> </span><span class="o">(</span><span class="m">1000</span><span class="w"> </span>ms<span class="o">)</span> <span class="m">2022</span>-Aug-31<span class="w"> </span><span class="m">04</span>:59:21.0546<span class="w"> </span><span class="m">117717</span>:117717<span class="w"> </span>ERROR<span class="w"> </span>TDRV:tsync_wait_nc_stop<span class="w"> </span>nd0<span class="w"> </span>nc0<span class="w"> </span>Error<span class="w"> </span><span class="k">while</span><span class="w"> </span>waiting<span class="w"> </span><span class="k">for</span><span class="w"> </span>timestamp<span class="w"> </span>program<span class="w"> </span>to<span class="w"> </span>end<span class="w"> </span>on<span class="w"> </span>TPB<span class="w"> </span>eng<span class="w"> </span><span class="m">0</span> <span class="m">2022</span>-Aug-31<span class="w"> </span><span class="m">04</span>:59:21.0546<span class="w"> </span><span class="m">117717</span>:117717<span class="w"> </span>ERROR<span class="w"> </span>TDRV:tsync_timestamps_finish<span class="w"> </span>nd0<span class="w"> </span>nc0<span class="w"> </span>Failed<span class="w"> </span>to<span class="w"> </span>stop<span class="w"> </span>neuron<span class="w"> </span>core <span class="m">2022</span>-Aug-31<span class="w"> </span><span class="m">04</span>:59:21.0546<span class="w"> </span><span class="m">117717</span>:117717<span class="w"> </span>ERROR<span class="w"> </span>TDRV:tdrv_tsync_timestamps<span class="w"> </span>nd0<span class="w"> </span>nc0<span class="w"> </span>Failed<span class="w"> </span>to<span class="w"> </span>end<span class="w"> </span>timestamp<span class="w"> </span>sync<span class="w"> </span>programs <span class="m">2022</span>-Aug-31<span class="w"> </span><span class="m">04</span>:59:22.0768<span class="w"> </span><span class="m">117717</span>:117717<span class="w"> </span>ERROR<span class="w"> </span>TDRV:tdrv_destroy<span class="w"> </span>TDRV<span class="w"> </span>not<span class="w"> </span>initialized <span class="m">2022</span>-Aug-31<span class="w"> </span><span class="m">04</span>:59:22.0768<span class="w"> </span><span class="m">117717</span>:117717<span class="w"> </span>ERROR<span class="w"> </span>NRT:nrt_init<span class="w"> </span>Failed<span class="w"> </span>to<span class="w"> </span>initialize<span class="w"> </span>devices,<span class="w"> </span>error:5 </pre></div> </div> </div> <div class="section" id="compiler-error-module-numpy-has-no-attribute-asscalar"> <h3><a class="toc-backref" href="#id25">Compiler error “module ‘numpy’ has no attribute ‘asscalar’”</a><a class="headerlink" href="#compiler-error-module-numpy-has-no-attribute-asscalar" title="Permalink to this headline">#</a></h3> <p>When you have a newer version of numpy in the Python environment, compilations may fail with the “error module ‘numpy’ has no attribute ‘asscalar’”. Please note the neuronx-cc has the following dependency on numpy “numpy&lt;=1.20.0,&gt;=1.13.3”. To workaround this error, please do “pip install –force-reinstall neuronx-cc” to reinstall neuronx-cc with the proper dependencies.</p> <div class="highlight-base notranslate"><div class="highlight"><pre><span></span>ERROR 227874 [neuronx-cc]: *************************************************************** ERROR 227874 [neuronx-cc]: An Internal Compiler Error has occurred ERROR 227874 [neuronx-cc]: *************************************************************** ERROR 227874 [neuronx-cc]: ERROR 227874 [neuronx-cc]: Error message: module 'numpy' has no attribute 'asscalar' ERROR 227874 [neuronx-cc]: ERROR 227874 [neuronx-cc]: Error class: AttributeError ERROR 227874 [neuronx-cc]: Error location: Unknown ERROR 227874 [neuronx-cc]: Version information: ERROR 227874 [neuronx-cc]: NeuronX Compiler version 2.1.0.76+2909d26a2 ERROR 227874 [neuronx-cc]: ERROR 227874 [neuronx-cc]: HWM version 2.1.0.7-64eaede08 ERROR 227874 [neuronx-cc]: NEFF version Dynamic ERROR 227874 [neuronx-cc]: TVM not available ERROR 227874 [neuronx-cc]: NumPy version 1.23.3 ERROR 227874 [neuronx-cc]: MXNet not available ERROR 227874 [neuronx-cc]: </pre></div> </div> </div> <div class="section" id="import-errors-generic-type-type-irvalue-is-already-registered-or-generic-type-type-xlabuilder-is-already-registered"> <h3><a class="toc-backref" href="#id26">Import errors ‘generic_type: type “IrValue” is already registered!’ or ‘generic_type: type “XlaBuilder” is already registered!’</a><a class="headerlink" href="#import-errors-generic-type-type-irvalue-is-already-registered-or-generic-type-type-xlabuilder-is-already-registered" title="Permalink to this headline">#</a></h3> <p>When you encounter a PyTorch import error ‘import _XLAC … generic_type: type “IrValue” is already registered!’ or ‘import _XLAC … generic_type: type “XlaBuilder” is already registered!’, please check that TensorFlow and/or JAX are not installed in the Python environment. If they are installed, please uninstall them.</p> </div> <div class="section" id="import-error-import-xlac-importerror-site-packages-xlac-cpython-38-x86-64-linux-gnu-so-undefined-symbol"> <h3><a class="toc-backref" href="#id27">Import error “import _XLAC ImportError: &lt;&gt;/site-packages/_XLAC.cpython-38-x86_64-linux-gnu.so: undefined symbol”</a><a class="headerlink" href="#import-error-import-xlac-importerror-site-packages-xlac-cpython-38-x86-64-linux-gnu-so-undefined-symbol" title="Permalink to this headline">#</a></h3> <dl class="simple"> <dt>When you encounter a PyTorch import error “import _XLAC ImportError: &lt;&gt;/site-packages/_XLAC.cpython-38-x86_64-linux-gnu.so: undefined symbol” during execution, please check:</dt><dd><ol class="arabic simple"> <li><p>TensorFlow and/or JAX are not installed in the Python environment. If they are installed, please uninstall them.</p></li> <li><p>The installed PyTorch (torch) package major/minor versions match the installed torch-neuronx package’s major/minor versions (ie. 1.11). If they don’t match, please install the version of PyTorch that matches torch-neuronx.</p></li> </ol> </dd> </dl> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Traceback<span class="w"> </span><span class="o">(</span>most<span class="w"> </span>recent<span class="w"> </span>call<span class="w"> </span>last<span class="o">)</span>: <span class="w"> </span>File<span class="w"> </span><span class="s2">"/opt/ml/mlp_train.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">11</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span>import<span class="w"> </span>torch_xla.core.xla_model<span class="w"> </span>as<span class="w"> </span>xm <span class="w"> </span>File<span class="w"> </span><span class="s2">"/usr/local/lib/python3.8/site-packages/torch_xla/__init__.py"</span>,<span class="w"> </span>line<span class="w"> </span><span class="m">117</span>,<span class="w"> </span><span class="k">in</span><span class="w"> </span>&lt;module&gt; <span class="w"> </span>import<span class="w"> </span>_XLAC ImportError:<span class="w"> </span>/usr/local/lib/python3.8/site-packages/_XLAC.cpython-38-x86_64-linux-gnu.so:<span class="w"> </span>undefined<span class="w"> </span>symbol:<span class="w"> </span>_ZNK3c1010TensorImpl7stridesEv </pre></div> </div> <div class="section" id="nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1"> <h4>NaNs seen with transformers version &gt;= 4.21.0 when running HF BERT fine-tuning or pretraining with XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1<a class="headerlink" href="#nans-seen-with-transformers-version-4-21-0-when-running-hf-bert-fine-tuning-or-pretraining-with-xla-use-bf16-1-or-xla-downcast-bf16-1" title="Permalink to this headline">#</a></h4> <p>When running HuggingFace BERT (any size) fine-tuning tutorial or pretraining tutorial with transformers version &gt;= 4.21.0 and using XLA_USE_BF16=1 or XLA_DOWNCAST_BF16=1, you will see NaNs in the loss immediately at the first step. More details on the issue can be found at <a class="reference external" href="https://github.com/pytorch/xla/issues/4152">pytorch/xla#4152</a>. The workaround is to use 4.20.0 or earlier (the tutorials currently recommend version 4.15.0) or add <code class="docutils literal notranslate"><span class="pre">transformers.modeling_utils.get_parameter_dtype</span> <span class="pre">=</span> <span class="pre">lambda</span> <span class="pre">x:</span> <span class="pre">torch.bfloat16</span></code> to the Python script.</p> </div> </div> <div class="section" id="network-connectivity-issue-on-trn1-trn1n-32xlarge-with-ubuntu"> <span id="trn1-ubuntu-troubleshooting"></span><h3><a class="toc-backref" href="#id28">Network Connectivity Issue on trn1/trn1n 32xlarge with Ubuntu</a><a class="headerlink" href="#network-connectivity-issue-on-trn1-trn1n-32xlarge-with-ubuntu" title="Permalink to this headline">#</a></h3> <p><strong>Description</strong></p> <p>Ubuntu distributions have network connectivity issues when multiple interfaces are connected to the same subnet. trn1/trn1n 32xlarge comes with 8/16 network interfaces. (To launch trn1/trn1n with 8/16 interfaces please follow <a class="reference internal" href="setup-trn1-multi-node-execution.html#setup-trn1-multi-node-execution"><span class="std std-ref">here</span></a>)</p> <p>AWS publishes a package that installs a helper service to address the issue. This service runs at the startup, creates the appropriate netplan files, updates the netplan and the the instance networking and terminates.</p> <p>Note that the following fix is only required on instances launched using generic Ubuntu AMIs. Neuron AMIs and instances launched via ParalleCluster do not require the fix.</p> <p><strong>Patch to fix networking on a multi-interface instance</strong></p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>wget<span class="w"> </span>-O<span class="w"> </span>/tmp/aws-ubuntu-eni-helper.deb<span class="w"> </span><span class="s1">'https://github.com/aws-samples/aws-efa-nccl-baseami-pipeline/blob/master/nvidia-efa-ami_base/networking/aws-ubuntu-eni-helper_0.3-1_all.deb?raw=true'</span> sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>/tmp/aws-ubuntu-eni-helper.deb<span class="w"> </span>-y sudo<span class="w"> </span>systemctl<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>aws-ubuntu-eni-helper.service sudo<span class="w"> </span>systemctl<span class="w"> </span>start<span class="w"> </span>aws-ubuntu-eni-helper.service </pre></div> </div> <p><strong>How to apply the patch?</strong></p> <p>The following steps could be followed to resolve this issue:</p> <ul class="simple"> <li><p>Launch trn1.32xl from AWS console (starts with <code class="docutils literal notranslate"><span class="pre">single</span> <span class="pre">interface</span></code>, does not suffer from the multi-interface issue)</p></li> <li><p>Apply the patch on this newly launched single-interface instance</p></li> <li><p>Create a new AMI from this instance</p></li> <li><p>Launch an 8 or 16 interface instance using that AMI.</p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The patch installs and enables the service but does not run it. This is intentional. The service will run at the startup when the AMI is used to launch a multi-interface instance.</p> </div> <p><strong>FAQs</strong></p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Neuron DLAMI has the patch installed, users are always encouraged to launch the instances using the DLAMI which does not require any fix. Please refer to the <a class="reference internal" href="../../../general/setup/index.html#setup-guide-index"><span class="std std-ref">Set Up Guide</span></a> to know how to launch an instance using DLAMI.</p> </div> </div> <div class="section" id="too-many-open-files-when-running-training-job"> <h3><a class="toc-backref" href="#id29">“Too many open files” when running training job</a><a class="headerlink" href="#too-many-open-files-when-running-training-job" title="Permalink to this headline">#</a></h3> <p>When running a large model training with several workers, it can result in errors like the following.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">2023</span>-Jun-14<span class="w"> </span><span class="m">19</span>:05:29.0312<span class="w"> </span><span class="m">4112959</span>:4113326<span class="w"> </span><span class="o">[</span><span class="m">23</span><span class="o">]</span><span class="w"> </span>bootstrap.cc:106<span class="w"> </span>CCOM<span class="w"> </span>WARN<span class="w"> </span>Call<span class="w"> </span>to<span class="w"> </span>accept<span class="w"> </span>failed<span class="w"> </span>:<span class="w"> </span>Too<span class="w"> </span>many<span class="w"> </span>open<span class="w"> </span>files <span class="m">2023</span>-Jun-14<span class="w"> </span><span class="m">19</span>:05:29.0312<span class="w"> </span><span class="m">4112959</span>:4113263<span class="w"> </span><span class="o">[</span><span class="m">14</span><span class="o">]</span><span class="w"> </span>include/socket.h:438<span class="w"> </span>CCOM<span class="w"> </span>WARN<span class="w"> </span>Net<span class="w"> </span>:<span class="w"> </span>Socket<span class="w"> </span>creation<span class="w"> </span>failed<span class="w"> </span>:<span class="w"> </span>Too<span class="w"> </span>many<span class="w"> </span>open<span class="w"> </span>files <span class="m">2023</span>-Jun-14<span class="w"> </span><span class="m">19</span>:05:29.0312<span class="w"> </span><span class="m">4112959</span>:4113326<span class="w"> </span>ERROR<span class="w"> </span>ENC:ncclBootstrapRecv<span class="w"> </span>failed<span class="w"> </span>neuronBootstrapRecv<span class="w"> </span>request<span class="w"> </span>to<span class="w"> </span>NCCL <span class="m">2023</span>-Jun-14<span class="w"> </span><span class="m">19</span>:05:29.0312<span class="w"> </span><span class="m">4112959</span>:4113249<span class="w"> </span><span class="o">[</span><span class="m">12</span><span class="o">]</span><span class="w"> </span>bootstrap.cc:106<span class="w"> </span>CCOM<span class="w"> </span>WARN<span class="w"> </span>Call<span class="w"> </span>to<span class="w"> </span>accept<span class="w"> </span>failed<span class="w"> </span>:<span class="w"> </span>Too<span class="w"> </span>many<span class="w"> </span>open<span class="w"> </span>files <span class="m">2023</span>-Jun-14<span class="w"> </span><span class="m">19</span>:05:29.0312<span class="w"> </span><span class="m">4112959</span>:4113263<span class="w"> </span>ERROR<span class="w"> </span>ENC:ncclBootstrapSend<span class="w"> </span>failed<span class="w"> </span>neuronBootstrapSend<span class="w"> </span>request<span class="w"> </span>to<span class="w"> </span>NCCL2023-Jun-14<span class="w"> </span><span class="m">19</span>:05:29.03122023-Jun-14<span class="w"> </span><span class="m">19</span>:05:29.0312<span class="w"> </span><span class="m">4112959</span>:4113270<span class="w"> </span><span class="o">[</span><span class="m">15</span><span class="o">]</span><span class="w"> </span>bootstrap.cc:106<span class="w"> </span>CCOM<span class="w"> </span>WARN<span class="w"> </span>Call<span class="w"> </span>to<span class="w"> </span>accept<span class="w"> </span>failed<span class="w"> </span>:<span class="w"> </span>Too<span class="w"> </span>many<span class="w"> </span>open<span class="w"> </span>files </pre></div> </div> <p>This can result when the default OS limits is low. The hard and soft limits can be set on OS using the following commands or by manually opening and setting the limits.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>sed<span class="w"> </span>-i<span class="w"> </span><span class="s1">'H;1h;$!d;x;/hard *nofile/!s/$/\n* hard nofile 65536/'</span><span class="w"> </span>/etc/security/limits.conf sudo<span class="w"> </span>sed<span class="w"> </span>-i<span class="w"> </span><span class="s1">'H;1h;$!d;x;/soft *nofile/!s/$/\n* soft nofile 65536/'</span><span class="w"> </span>/etc/security/limits.conf sudo<span class="w"> </span>sed<span class="w"> </span>-i<span class="w"> </span><span class="s1">'s/^#*\(\*\|\s*\*\)\s*soft\s*nofile\s*[0-9]\+$/\1 soft nofile 65536/'</span><span class="w"> </span>/etc/security/limits.conf sudo<span class="w"> </span>sed<span class="w"> </span>-i<span class="w"> </span><span class="s1">'s/^#*\(\*\|\s*\*\)\s*hard\s*nofile\s*[0-9]\+$/\1 hard nofile 65536/'</span><span class="w"> </span>/etc/security/limits.conf sudo<span class="w"> </span>sed<span class="w"> </span>-i<span class="w"> </span><span class="s1">'s/^#*\(\*\|\s*\*\)\s*soft\s*nofile\s*[0-9]\+$/\1 soft nofile 65536/'</span><span class="w"> </span>/etc/security/limits.d/01_efa.conf<span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="nb">true</span> sudo<span class="w"> </span>sed<span class="w"> </span>-i<span class="w"> </span><span class="s1">'s/^#*\(\*\|\s*\*\)\s*hard\s*nofile\s*[0-9]\+$/\1 hard nofile 65536/'</span><span class="w"> </span>/etc/security/limits.d/01_efa.conf<span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="nb">true</span> </pre></div> </div> <p>The <cite>01_efa.conf</cite> file is created as part of the EFA installation and needs to be updated. If EFA driver is not installed the file <cite>01_efa.conf</cite> doesn’t exist and the sed commands will fail with <cite>No such file or directory</cite>. If there are other files under <cite>limits.d</cite> with file limits they need to be updated as well.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="setup-trn1-multi-node-execution.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">How to prepare trn1.32xlarge for multi-node execution</p> </div> </a> <a class="right-next" id="next-link" href="../../tensorflow/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow Neuron</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:12.351Z
TensorFlow Neuron — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/index.html
# TensorFlow Neuron — AWS Neuron Documentation _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` ## TensorFlow Neuron[#](#tensorflow-neuron "Permalink to this headline") TensorFlow Neuron unlocks high-performance and cost-effective deep learning acceleration on AWS Trainium-based and Inferentia-based Amazon EC2 instances. TensorFlow Neuron enables native TensorFlow models to be accelerated on Neuron devices, so you can use your existing framework application and get started easily with minimal code changes. Tensorflow Neuron(`tensorflow-neuronx`) for Inference on `Inf2` & `Trn1` / `Trn1n` Tensorflow Neuron(`tensorflow-neuron`) for Inference on `Inf1` _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow Neuron — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Tensorflow Neuron Setup" href="tensorflow-setup.html"> <link rel="prev" title="PyTorch Neuron (torch-neuronx) for Training Troubleshooting Guide" href="../torch/torch-neuronx/training-troubleshooting.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/index", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="current reference internal" href="#"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/index.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/index.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/tensorflow/index.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow Neuron</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="tensorflow-neuron"> <span id="tensorflow-neuron-main"></span><span id="id1"></span><h1>TensorFlow Neuron<a class="headerlink" href="#tensorflow-neuron" title="Permalink to this headline">#</a></h1> <p>TensorFlow Neuron unlocks high-performance and cost-effective deep learning acceleration on AWS Trainium-based and Inferentia-based Amazon EC2 instances.</p> <p>TensorFlow Neuron enables native TensorFlow models to be accelerated on Neuron devices, so you can use your existing framework application and get started easily with minimal code changes.</p> <div class="toctree-wrapper compound"> </div> <div class="toctree-wrapper compound"> </div> <div class="toctree-wrapper compound"> </div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Tensorflow Neuron(<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) for Inference on <code class="docutils literal notranslate"><span class="pre">Inf2</span></code> &amp; <code class="docutils literal notranslate"><span class="pre">Trn1</span></code> / <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></div> </div> <a class="sd-stretched-link reference internal" href="tensorflow-neuronx-inference.html#inference-tensorflow-neuronx"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Tensorflow Neuron(<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) for Inference on <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></div> </div> <a class="sd-stretched-link reference internal" href="tensorflow-neuron-inference.html#inference-tensorflow-neuron"><span class="std std-ref"></span></a></div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../torch/torch-neuronx/training-troubleshooting.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">PyTorch Neuron (<code class="docutils literal notranslate"><span class="pre">torch-neuronx</span></code>) for Training Troubleshooting Guide</p> </div> </a> <a class="right-next" id="next-link" href="tensorflow-setup.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Tensorflow Neuron Setup</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:12.722Z
Tensorflow Neuron Setup — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-setup.html
# Tensorflow Neuron Setup — AWS Neuron Documentation _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` ## Tensorflow Neuron Setup[#](#tensorflow-neuron-setup "Permalink to this headline") Tensorflow Neuron (`tensorflow-neuronx`) Setup for Inf2, Trn1/Trn1n Instances Tensorflow Neuron (`tensorflow-neuron`) Setup for Inf1 Instances _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Tensorflow Neuron Setup — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Inference on Inf2 &amp; Trn1/Trn1n (tensorflow-neuronx)" href="tensorflow-neuronx-inference.html"> <link rel="prev" title="TensorFlow Neuron" href="index.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-setup", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2 current active"> <a class="current reference internal" href="#"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-setup.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-setup.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/tensorflow/tensorflow-setup.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Tensorflow Neuron Setup</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="tensorflow-neuron-setup"> <span id="tf-setup"></span><h1>Tensorflow Neuron Setup<a class="headerlink" href="#tensorflow-neuron-setup" title="Permalink to this headline">#</a></h1> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Tensorflow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Setup for Inf2, Trn1/Trn1n Instances</div> </div> <a class="sd-stretched-link reference internal" href="../../general/setup/tensorflow-neuronx.html#setup-tensorflow-neuronx"><span class="std std-ref"></span></a></div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Tensorflow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Setup for Inf1 Instances</div> </div> <a class="sd-stretched-link reference internal" href="../../general/setup/tensorflow-neuron.html#setup-tensorflow-neuron"><span class="std std-ref"></span></a></div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="index.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow Neuron</p> </div> </a> <a class="right-next" id="next-link" href="tensorflow-neuronx-inference.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Inference on Inf2 &amp; Trn1/Trn1n (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:12.950Z
Inference on Inf2 & Trn1/Trn1n (tensorflow-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuronx-inference.html
# Inference on Inf2 & Trn1/Trn1n (tensorflow-neuronx) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx-inference.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx-inference.rst) - [.rst](../../_sources/frameworks/tensorflow/tensorflow-neuronx-inference.rst.txt) ## Inference on Inf2 & Trn1/Trn1n (tensorflow-neuronx) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Inference on Inf2 & Trn1/Trn1n (`tensorflow-neuronx`)[#](#inference-on-inf2-trn1-trn1n-tensorflow-neuronx "Permalink to this headline") Setup (`tensorflow-neuronx`) Tutorials (`tensorflow-neuronx`) - HuggingFace Roberta-Base [\[html\]](../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.ipynb) - [Using NEURON\_RT\_VISIBLE\_CORES with TensorFlow Serving](tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html#tensorflow-servingx-neuronrt-visible-cores) Note To use Jupyter Notebook see: - [Jupyter Notebook QuickStart](../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting) - [Running Jupyter Notebook as script](../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script) API Reference Guide (`tensorflow-neuronx`) - [TensorFlow 2.x (tensorflow-neuronx) Tracing API](tensorflow-neuronx/tfneuronx-python-tracing-api.html#tfneuronx-ref-neuron-tracing-api) - [TensorFlow Neuron (tensorflow-neuronx) Auto Multicore Replication (Experimental)](tensorflow-neuronx/tf-neuronx-auto-replication-api.html#tf-neuronx-ref-auto-replication-python-api) - [TensorFlow 2.x (tensorflow-neuronx) analyze\_model API](tensorflow-neuronx/tfnx-analyze-model-api.html#tf-neuronx-ref-analyze-model-api) Misc (`tensorflow-neuronx`) - [TensorFlow Neuron (tensorflow-neuronx) Release Notes](../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html#tensorflow-neuronx-release-notes) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Inference on Inf2 &amp; Trn1/Trn1n (tensorflow-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Tutorials (tensorflow-neuronx)" href="tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> <link rel="prev" title="Tensorflow Neuron Setup" href="tensorflow-setup.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuronx-inference", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="current reference internal" href="#"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx-inference.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx-inference.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/tensorflow/tensorflow-neuronx-inference.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Inference on Inf2 &amp; Trn1/Trn1n (tensorflow-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="inference-on-inf2-trn1-trn1n-tensorflow-neuronx"> <span id="inference-tensorflow-neuronx"></span><h1>Inference on Inf2 &amp; Trn1/Trn1n (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)<a class="headerlink" href="#inference-on-inf2-trn1-trn1n-tensorflow-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Setup (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)</div> </div> <a class="sd-stretched-link reference internal" href="../../general/setup/tensorflow-neuronx.html#setup-tensorflow-neuronx"><span class="std std-ref"></span></a></div> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-med"> Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body docutils"> <ul class="simple"> <li><p class="sd-card-text">HuggingFace Roberta-Base <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html#tensorflow-servingx-neuronrt-visible-cores"><span class="std std-ref">Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving</span></a></p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p class="sd-card-text">To use Jupyter Notebook see:</p> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-med"> API Reference Guide (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="tensorflow-neuronx/tfneuronx-python-tracing-api.html#tfneuronx-ref-neuron-tracing-api"><span class="std std-ref">TensorFlow 2.x (tensorflow-neuronx) Tracing API</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="tensorflow-neuronx/tf-neuronx-auto-replication-api.html#tf-neuronx-ref-auto-replication-python-api"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuronx) Auto Multicore Replication (Experimental)</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="tensorflow-neuronx/tfnx-analyze-model-api.html#tf-neuronx-ref-analyze-model-api"><span class="std std-ref">TensorFlow 2.x (tensorflow-neuronx) analyze_model API</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-med"> Misc (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html#tensorflow-neuronx-release-notes"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuronx) Release Notes</span></a></p></li> </ul> </div> </details><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tensorflow-setup.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Tensorflow Neuron Setup</p> </div> </a> <a class="right-next" id="next-link" href="tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:13.556Z
Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html
# Using NEURON\_RT\_VISIBLE\_CORES with TensorFlow Serving — AWS Neuron Documentation Toggle in-page Table of Contents Contents - [Install TensorFlow Model Server and Serving API](#install-tensorflow-model-server-and-serving-api) - [Export and Compile Saved Model](#export-and-compile-saved-model) - [Serving Saved Model](#serving-saved-model) - [Generate inference requests to the model server](#generate-inference-requests-to-the-model-server) ## Contents - [Install TensorFlow Model Server and Serving API](#install-tensorflow-model-server-and-serving-api) - [Export and Compile Saved Model](#export-and-compile-saved-model) - [Serving Saved Model](#serving-saved-model) - [Generate inference requests to the model server](#generate-inference-requests-to-the-model-server) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Using NEURON\_RT\_VISIBLE\_CORES with TensorFlow Serving[#](#using-neuron-rt-visible-cores-with-tensorflow-serving "Permalink to this headline") TensorFlow serving allows customers to scale-up inference workloads across a network. TensorFlow Neuron Serving uses the same API as normal TensorFlow Serving with two differences: (a) the saved model must be compiled for neuron and (b) the entry point is a different binary named `tensorflow_model_server_neuron`. The binary is found at `/usr/local/bin/tensorflow_model_server_neuron` and is pre-installed in the DLAMI or installed with APT/YUM tensorflow-model-server-neuronx package. ## Install TensorFlow Model Server and Serving API[#](#install-tensorflow-model-server-and-serving-api "Permalink to this headline") Follow the steps in the install-neuronx-tensorflow. Then ensure you install using either apt-get or yum. ``` sudo apt-get install tensorflow-model-server-neuronx ``` or ``` sudo yum install tensorflow-model-server-neuronx ``` Also, you would need TensorFlow Serving API (use –no-deps to prevent installation of regular tensorflow). ``` pip install --no-deps tensorflow_serving_api ``` For the example image preprocessing using Keras preprocessing, the Python Imaging Library Pillow is required: To workaround h5py issue [https://github.com/aws/aws-neuron-sdk/issues/220](https://github.com/aws/aws-neuron-sdk/issues/220): ## Export and Compile Saved Model[#](#export-and-compile-saved-model "Permalink to this headline") The following example shows graph construction followed by the addition of Neuron compilation step before exporting to saved model. ``` import tensorflow as tf import tensorflow_neuronx as tfnx import numpy as np tf.keras.backend.set_learning_phase(0) tf.keras.backend.set_image_data_format('channels_last') image_sizes = [224, 224] model = tf.keras.applications.ResNet50(weights='imagenet') example_inputs = tf.random.uniform([1, *image_sizes, 3], dtype=tf.float32) model_neuron = tfnx.trace(model, example_inputs) # run the model once to define the forward pass and allow for saving model_neuron(example_inputs) tf.keras.models.save_model(model_neuron, './resnet50_neuron/1') ``` ## Serving Saved Model[#](#serving-saved-model "Permalink to this headline") User can now serve the saved model with the tensorflow\_model\_server\_neuron binary. To utilize multiple NeuronCores, it is recommended to launch multiple tensorflow model servers that listen to the same gRPC port: ``` export NEURON_RT_VISIBLE_CORES=0 # important to set this environment variable before launching model servers tensorflow_model_server_neuron --model_name=resnet50_neuron \ --model_base_path=$(pwd)/resnet50_neuron/ --port=8500 # then to run another server on a different neuron core open another # window and run this, except this time set NEURON_RT_VISIBLE_CORES=1 # you can keep doing this up to the number of Neuron Cores on your machine export NEURON_RT_VISIBLE_CORES=1 tensorflow_model_server_neuron --model_name=resnet50_neuron \ --model_base_path=$(pwd)/resnet50_neuron/ --port=8500 ``` The compiled model is staged in neuron DRAM by the server to prepare for inference. ## Generate inference requests to the model server[#](#generate-inference-requests-to-the-model-server "Permalink to this headline") Now run inferences via GRPC as shown in the following sample client code: ``` import numpy as np import grpc import tensorflow as tf from tensorflow.keras.preprocessing import image from tensorflow.keras.applications.resnet50 import preprocess_input from tensorflow_serving.apis import predict_pb2 from tensorflow_serving.apis import prediction_service_pb2_grpc from tensorflow.keras.applications.resnet50 import decode_predictions tf.keras.backend.set_image_data_format('channels_last') if __name__ == '__main__': channel = grpc.insecure_channel('localhost:8500') stub = prediction_service_pb2_grpc.PredictionServiceStub(channel) img_file = tf.keras.utils.get_file( "./kitten_small.jpg", "https://raw.githubusercontent.com/awslabs/mxnet-model-server/master/docs/images/kitten_small.jpg") img = image.load_img(img_file, target_size=(224, 224)) img_array = preprocess_input(image.img_to_array(img)[None, ...]) request = predict_pb2.PredictRequest() request.model_spec.name = 'resnet50_neuron' request.inputs['input_1'].CopyFrom( tf.make_tensor_proto(img_array, shape=img_array.shape)) result = stub.Predict(request) prediction = tf.make_ndarray(result.outputs['output_1']) print(decode_predictions(prediction)) ``` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="API Reference Guide (tensorflow-neuronx)" href="../api-reference-guide.html"> <link rel="prev" title="Running Huggingface Roberta-Base with TensorFlow-NeuronX" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-tensorflow-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#install-tensorflow-model-server-and-serving-api"> Install TensorFlow Model Server and Serving API </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#export-and-compile-saved-model"> Export and Compile Saved Model </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#serving-saved-model"> Serving Saved Model </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#generate-inference-requests-to-the-model-server"> Generate inference requests to the model server </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#install-tensorflow-model-server-and-serving-api"> Install TensorFlow Model Server and Serving API </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#export-and-compile-saved-model"> Export and Compile Saved Model </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#serving-saved-model"> Serving Saved Model </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#generate-inference-requests-to-the-model-server"> Generate inference requests to the model server </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="using-neuron-rt-visible-cores-with-tensorflow-serving"> <span id="tensorflow-servingx-neuronrt-visible-cores"></span><h1>Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving<a class="headerlink" href="#using-neuron-rt-visible-cores-with-tensorflow-serving" title="Permalink to this headline">#</a></h1> <p>TensorFlow serving allows customers to scale-up inference workloads across a network. TensorFlow Neuron Serving uses the same API as normal TensorFlow Serving with two differences: (a) the saved model must be compiled for neuron and (b) the entry point is a different binary named <code class="docutils literal notranslate"><span class="pre">tensorflow_model_server_neuron</span></code>. The binary is found at <code class="docutils literal notranslate"><span class="pre">/usr/local/bin/tensorflow_model_server_neuron</span></code> and is pre-installed in the DLAMI or installed with APT/YUM tensorflow-model-server-neuronx package.</p> <div class="section" id="install-tensorflow-model-server-and-serving-api"> <h2>Install TensorFlow Model Server and Serving API<a class="headerlink" href="#install-tensorflow-model-server-and-serving-api" title="Permalink to this headline">#</a></h2> <p>Follow the steps in the <span class="xref std std-ref">install-neuronx-tensorflow</span>.</p> <p>Then ensure you install using either apt-get or yum.</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>tensorflow-model-server-neuronx </pre></div> </div> <p>or</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>tensorflow-model-server-neuronx </pre></div> </div> <p>Also, you would need TensorFlow Serving API (use –no-deps to prevent installation of regular tensorflow).</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>--no-deps<span class="w"> </span>tensorflow_serving_api </pre></div> </div> <p>For the example image preprocessing using Keras preprocessing, the Python Imaging Library Pillow is required:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>pillow </pre></div> </div> <p>To workaround h5py issue <a class="reference external" href="https://github.com/aws/aws-neuron-sdk/issues/220">https://github.com/aws/aws-neuron-sdk/issues/220</a>:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span><span class="s2">"h5py&lt;3.0.0"</span> </pre></div> </div> </div> <div class="section" id="export-and-compile-saved-model"> <h2>Export and Compile Saved Model<a class="headerlink" href="#export-and-compile-saved-model" title="Permalink to this headline">#</a></h2> <p>The following example shows graph construction followed by the addition of Neuron compilation step before exporting to saved model.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">import</span> <span class="nn">tensorflow_neuronx</span> <span class="k">as</span> <span class="nn">tfnx</span> <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">backend</span><span class="o">.</span><span class="n">set_learning_phase</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">backend</span><span class="o">.</span><span class="n">set_image_data_format</span><span class="p">(</span><span class="s1">'channels_last'</span><span class="p">)</span> <span class="n">image_sizes</span> <span class="o">=</span> <span class="p">[</span><span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">]</span> <span class="n">model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">applications</span><span class="o">.</span><span class="n">ResNet50</span><span class="p">(</span><span class="n">weights</span><span class="o">=</span><span class="s1">'imagenet'</span><span class="p">)</span> <span class="n">example_inputs</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="o">*</span><span class="n">image_sizes</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="n">dtype</span><span class="o">=</span><span class="n">tf</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">tfnx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">)</span> <span class="c1"># run the model once to define the forward pass and allow for saving</span> <span class="n">model_neuron</span><span class="p">(</span><span class="n">example_inputs</span><span class="p">)</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">save_model</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="s1">'./resnet50_neuron/1'</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="serving-saved-model"> <h2>Serving Saved Model<a class="headerlink" href="#serving-saved-model" title="Permalink to this headline">#</a></h2> <p>User can now serve the saved model with the tensorflow_model_server_neuron binary. To utilize multiple NeuronCores, it is recommended to launch multiple tensorflow model servers that listen to the same gRPC port:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_VISIBLE_CORES</span><span class="o">=</span><span class="m">0</span><span class="w"> </span><span class="c1"># important to set this environment variable before launching model servers</span> tensorflow_model_server_neuron<span class="w"> </span>--model_name<span class="o">=</span>resnet50_neuron<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--model_base_path<span class="o">=</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>/resnet50_neuron/<span class="w"> </span>--port<span class="o">=</span><span class="m">8500</span> <span class="c1"># then to run another server on a different neuron core open another</span> <span class="c1"># window and run this, except this time set NEURON_RT_VISIBLE_CORES=1</span> <span class="c1"># you can keep doing this up to the number of Neuron Cores on your machine</span> <span class="nb">export</span><span class="w"> </span><span class="nv">NEURON_RT_VISIBLE_CORES</span><span class="o">=</span><span class="m">1</span> tensorflow_model_server_neuron<span class="w"> </span>--model_name<span class="o">=</span>resnet50_neuron<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--model_base_path<span class="o">=</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>/resnet50_neuron/<span class="w"> </span>--port<span class="o">=</span><span class="m">8500</span> </pre></div> </div> <p>The compiled model is staged in neuron DRAM by the server to prepare for inference.</p> </div> <div class="section" id="generate-inference-requests-to-the-model-server"> <h2>Generate inference requests to the model server<a class="headerlink" href="#generate-inference-requests-to-the-model-server" title="Permalink to this headline">#</a></h2> <p>Now run inferences via GRPC as shown in the following sample client code:</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> <span class="kn">import</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">from</span> <span class="nn">tensorflow.keras.preprocessing</span> <span class="kn">import</span> <span class="n">image</span> <span class="kn">from</span> <span class="nn">tensorflow.keras.applications.resnet50</span> <span class="kn">import</span> <span class="n">preprocess_input</span> <span class="kn">from</span> <span class="nn">tensorflow_serving.apis</span> <span class="kn">import</span> <span class="n">predict_pb2</span> <span class="kn">from</span> <span class="nn">tensorflow_serving.apis</span> <span class="kn">import</span> <span class="n">prediction_service_pb2_grpc</span> <span class="kn">from</span> <span class="nn">tensorflow.keras.applications.resnet50</span> <span class="kn">import</span> <span class="n">decode_predictions</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">backend</span><span class="o">.</span><span class="n">set_image_data_format</span><span class="p">(</span><span class="s1">'channels_last'</span><span class="p">)</span> <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span> <span class="n">channel</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">insecure_channel</span><span class="p">(</span><span class="s1">'localhost:8500'</span><span class="p">)</span> <span class="n">stub</span> <span class="o">=</span> <span class="n">prediction_service_pb2_grpc</span><span class="o">.</span><span class="n">PredictionServiceStub</span><span class="p">(</span><span class="n">channel</span><span class="p">)</span> <span class="n">img_file</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">get_file</span><span class="p">(</span> <span class="s2">"./kitten_small.jpg"</span><span class="p">,</span> <span class="s2">"https://raw.githubusercontent.com/awslabs/mxnet-model-server/master/docs/images/kitten_small.jpg"</span><span class="p">)</span> <span class="n">img</span> <span class="o">=</span> <span class="n">image</span><span class="o">.</span><span class="n">load_img</span><span class="p">(</span><span class="n">img_file</span><span class="p">,</span> <span class="n">target_size</span><span class="o">=</span><span class="p">(</span><span class="mi">224</span><span class="p">,</span> <span class="mi">224</span><span class="p">))</span> <span class="n">img_array</span> <span class="o">=</span> <span class="n">preprocess_input</span><span class="p">(</span><span class="n">image</span><span class="o">.</span><span class="n">img_to_array</span><span class="p">(</span><span class="n">img</span><span class="p">)[</span><span class="kc">None</span><span class="p">,</span> <span class="o">...</span><span class="p">])</span> <span class="n">request</span> <span class="o">=</span> <span class="n">predict_pb2</span><span class="o">.</span><span class="n">PredictRequest</span><span class="p">()</span> <span class="n">request</span><span class="o">.</span><span class="n">model_spec</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s1">'resnet50_neuron'</span> <span class="n">request</span><span class="o">.</span><span class="n">inputs</span><span class="p">[</span><span class="s1">'input_1'</span><span class="p">]</span><span class="o">.</span><span class="n">CopyFrom</span><span class="p">(</span> <span class="n">tf</span><span class="o">.</span><span class="n">make_tensor_proto</span><span class="p">(</span><span class="n">img_array</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="n">img_array</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span> <span class="n">result</span> <span class="o">=</span> <span class="n">stub</span><span class="o">.</span><span class="n">Predict</span><span class="p">(</span><span class="n">request</span><span class="p">)</span> <span class="n">prediction</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">make_ndarray</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">outputs</span><span class="p">[</span><span class="s1">'output_1'</span><span class="p">])</span> <span class="nb">print</span><span class="p">(</span><span class="n">decode_predictions</span><span class="p">(</span><span class="n">prediction</span><span class="p">))</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Running Huggingface Roberta-Base with TensorFlow-NeuronX</p> </div> </a> <a class="right-next" id="next-link" href="../api-reference-guide.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">API Reference Guide (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:14.069Z
Running Huggingface Roberta-Base with TensorFlow-NeuronX — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html
# Running Huggingface Roberta-Base with TensorFlow-NeuronX — AWS Neuron Documentation ## Contents - [Setup](#Setup) - [Download From Huggingface and Compile for AWS-Neuron](#Download-From-Huggingface-and-Compile-for-AWS-Neuron) - [Run Basic Inference Benchmarking](#Run-Basic-Inference-Benchmarking) ## Running Huggingface Roberta-Base with TensorFlow-NeuronX[#](#Running-Huggingface-Roberta-Base-with-TensorFlow-NeuronX "Permalink to this headline") This tutorial demonstrates how to compile the Huggingface roberta-base model and infer on a trn1.2xlarge instance with `tensorflow-neuronx`. To compile larger models like roberta-large, please consider using an inf2 instance. ## Setup[#](#Setup "Permalink to this headline") To run this tutorial please follow the instructions for [TensorFlow-NeuronX Setup](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/tensorflow/tensorflow-neuronx/setup/tensorflow-neuronx-install.html) and the [Jupyter Notebook Quickstart](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html) and set your kernel to “Python (tensorflow-neuronx)”. Next, install some additional dependencies. ``` %env TOKENIZERS_PARALLELISM=True #Supresses tokenizer warnings making errors easier to detect !pip install transformers ``` ## Download From Huggingface and Compile for AWS-Neuron[#](#Download-From-Huggingface-and-Compile-for-AWS-Neuron "Permalink to this headline") ``` import tensorflow as tf import tensorflow_neuronx as tfnx from transformers import RobertaTokenizer, TFRobertaModel from transformers import BertTokenizer, TFBertModel # Create a wrapper for the roberta model that will accept inputs as a list # instead of a dictionary. This will allow the compiled model to be saved # to disk with the model.save() fucntion. class RobertaWrapper(tf.keras.Model): def __init__(self, model): super().__init__() self.model = model def __call__(self, example_inputs): return self.model({'input_ids' : example_inputs[0], 'attention_mask' : example_inputs[1]}) tokenizer = RobertaTokenizer.from_pretrained('roberta-base') model = RobertaWrapper(TFRobertaModel.from_pretrained('roberta-base')) batch_size = 16 # create example inputs with a batch size of 16 text = ["Paris is the <mask> of France."] * batch_size encoded_input = tokenizer(text, return_tensors='tf', padding='max_length', max_length=64) # turn inputs into a list example_input = [encoded_input['input_ids'], encoded_input['attention_mask']] #compile model_neuron = tfnx.trace(model, example_input) print("Running on neuron:", model_neuron(example_input)) # save the model to disk to save recompilation time for next usage model_neuron.save('./roberta-neuron-b16') ``` ## Run Basic Inference Benchmarking[#](#Run-Basic-Inference-Benchmarking "Permalink to this headline") ``` import numpy as np import concurrent.futures import time reloaded_neuron_model = tf.keras.models.load_model('./roberta-neuron-b16') print("Reloaded model running on neuron:", reloaded_neuron_model(example_input)) num_threads = 4 num_inferences = 1000 latency_list = [] def inference_with_latency_calculation(example_input): global latency_list start = time.time() result = reloaded_neuron_model(example_input) end = time.time() latency_list.append((end-start) * 1000) return result start = time.time() with concurrent.futures.ThreadPoolExecutor(max_workers=num_threads) as executor: futures = [] for i in range(num_inferences): futures.append(executor.submit(inference_with_latency_calculation, example_input)) for future in concurrent.futures.as_completed(futures): get_result = future.result() end = time.time() total_time = end - start print(f"Throughput was {(num_inferences * batch_size)/total_time} samples per second.") print(f"Latency p50 was {np.percentile(latency_list, 50)} ms") print(f"Latency p90 was {np.percentile(latency_list, 90)} ms") print(f"Latency p99 was {np.percentile(latency_list, 99)} ms") ```
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Running Huggingface Roberta-Base with TensorFlow-NeuronX — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script>window.MathJax = {"tex": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true}, "options": {"ignoreHtmlClass": "tex2jax_ignore|mathjax_ignore|document", "processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script> <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> <link rel="prev" title="Tutorials (tensorflow-neuronx)" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".ipynb", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <style type="text/css">.CtxtMenu_InfoClose { top:.2em; right:.2em;} .CtxtMenu_InfoContent { overflow:auto; text-align:left; font-size:80%; padding:.4em .6em; border:1px inset; margin:1em 0px; max-height:20em; max-width:30em; background-color:#EEEEEE; white-space:normal;} .CtxtMenu_Info.CtxtMenu_MousePost {outline:none;} .CtxtMenu_Info { position:fixed; left:50%; width:auto; text-align:center; border:3px outset; padding:1em 2em; background-color:#DDDDDD; color:black; cursor:default; font-family:message-box; font-size:120%; font-style:normal; text-indent:0; text-transform:none; line-height:normal; letter-spacing:normal; word-spacing:normal; word-wrap:normal; white-space:nowrap; float:none; z-index:201; border-radius: 15px; /* Opera 10.5 and IE9 */ -webkit-border-radius:15px; /* Safari and Chrome */ -moz-border-radius:15px; /* Firefox */ -khtml-border-radius:15px; /* Konqueror */ box-shadow:0px 10px 20px #808080; /* Opera 10.5 and IE9 */ -webkit-box-shadow:0px 10px 20px #808080; /* Safari 3 & Chrome */ -moz-box-shadow:0px 10px 20px #808080; /* Forefox 3.5 */ -khtml-box-shadow:0px 10px 20px #808080; /* Konqueror */ filter:progid:DXImageTransform.Microsoft.dropshadow(OffX=2, OffY=2, Color="gray", Positive="true"); /* IE */} </style><style type="text/css">.CtxtMenu_MenuClose { position:absolute; cursor:pointer; display:inline-block; border:2px solid #AAA; border-radius:18px; -webkit-border-radius: 18px; /* Safari and Chrome */ -moz-border-radius: 18px; /* Firefox */ -khtml-border-radius: 18px; /* Konqueror */ font-family: "Courier New", Courier; font-size:24px; color:#F0F0F0} .CtxtMenu_MenuClose span { display:block; background-color:#AAA; border:1.5px solid; border-radius:18px; -webkit-border-radius: 18px; /* Safari and Chrome */ -moz-border-radius: 18px; /* Firefox */ -khtml-border-radius: 18px; /* Konqueror */ line-height:0; padding:8px 0 6px /* may need to be browser-specific */} .CtxtMenu_MenuClose:hover { color:white!important; border:2px solid #CCC!important} .CtxtMenu_MenuClose:hover span { background-color:#CCC!important} .CtxtMenu_MenuClose:hover:focus { outline:none} </style><style type="text/css">.CtxtMenu_Menu { position:absolute; background-color:white; color:black; width:auto; padding:5px 0px; border:1px solid #CCCCCC; margin:0; cursor:default; font: menu; text-align:left; text-indent:0; text-transform:none; line-height:normal; letter-spacing:normal; word-spacing:normal; word-wrap:normal; white-space:nowrap; float:none; z-index:201; border-radius: 5px; /* Opera 10.5 and IE9 */ -webkit-border-radius: 5px; /* Safari and Chrome */ -moz-border-radius: 5px; /* Firefox */ -khtml-border-radius: 5px; /* Konqueror */ box-shadow:0px 10px 20px #808080; /* Opera 10.5 and IE9 */ -webkit-box-shadow:0px 10px 20px #808080; /* Safari 3 & Chrome */ -moz-box-shadow:0px 10px 20px #808080; /* Forefox 3.5 */ -khtml-box-shadow:0px 10px 20px #808080; /* Konqueror */} .CtxtMenu_MenuItem { padding: 1px 2em; background:transparent;} .CtxtMenu_MenuArrow { position:absolute; right:.5em; padding-top:.25em; color:#666666; font-family: null; font-size: .75em} .CtxtMenu_MenuActive .CtxtMenu_MenuArrow {color:white} .CtxtMenu_MenuArrow.CtxtMenu_RTL {left:.5em; right:auto} .CtxtMenu_MenuCheck { position:absolute; left:.7em; font-family: null} .CtxtMenu_MenuCheck.CtxtMenu_RTL { right:.7em; left:auto } .CtxtMenu_MenuRadioCheck { position:absolute; left: .7em;} .CtxtMenu_MenuRadioCheck.CtxtMenu_RTL { right: .7em; left:auto} .CtxtMenu_MenuInputBox { padding-left: 1em; right:.5em; color:#666666; font-family: null;} .CtxtMenu_MenuInputBox.CtxtMenu_RTL { left: .1em;} .CtxtMenu_MenuComboBox { left:.1em; padding-bottom:.5em;} .CtxtMenu_MenuSlider { left: .1em;} .CtxtMenu_SliderValue { position:absolute; right:.1em; padding-top:.25em; color:#333333; font-size: .75em} .CtxtMenu_SliderBar { outline: none; background: #d3d3d3} .CtxtMenu_MenuLabel { padding: 1px 2em 3px 1.33em; font-style:italic} .CtxtMenu_MenuRule { border-top: 1px solid #DDDDDD; margin: 4px 3px;} .CtxtMenu_MenuDisabled { color:GrayText} .CtxtMenu_MenuActive { background-color: #606872; color: white;} .CtxtMenu_MenuDisabled:focus { background-color: #E8E8E8} .CtxtMenu_MenuLabel:focus { background-color: #E8E8E8} .CtxtMenu_ContextMenu:focus { outline:none} .CtxtMenu_ContextMenu .CtxtMenu_MenuItem:focus { outline:none} .CtxtMenu_SelectionMenu { position:relative; float:left; border-bottom: none; -webkit-box-shadow:none; -webkit-border-radius:0px; } .CtxtMenu_SelectionItem { padding-right: 1em;} .CtxtMenu_Selection { right: 40%; width:50%; } .CtxtMenu_SelectionBox { padding: 0em; max-height:20em; max-width: none; background-color:#FFFFFF;} .CtxtMenu_SelectionDivider { clear: both; border-top: 2px solid #000000;} .CtxtMenu_Menu .CtxtMenu_MenuClose { top:-10px; left:-10px} </style><style id="MJX-CHTML-styles"> mjx-container[jax="CHTML"] { line-height: 0; } mjx-container [space="1"] { margin-left: .111em; } mjx-container [space="2"] { margin-left: .167em; } mjx-container [space="3"] { margin-left: .222em; } mjx-container [space="4"] { margin-left: .278em; } mjx-container [space="5"] { margin-left: .333em; } mjx-container [rspace="1"] { margin-right: .111em; } mjx-container [rspace="2"] { margin-right: .167em; } mjx-container [rspace="3"] { margin-right: .222em; } mjx-container [rspace="4"] { margin-right: .278em; } mjx-container [rspace="5"] { margin-right: .333em; } mjx-container [size="s"] { font-size: 70.7%; } mjx-container [size="ss"] { font-size: 50%; } mjx-container [size="Tn"] { font-size: 60%; } mjx-container [size="sm"] { font-size: 85%; } mjx-container [size="lg"] { font-size: 120%; } mjx-container [size="Lg"] { font-size: 144%; } mjx-container [size="LG"] { font-size: 173%; } mjx-container [size="hg"] { font-size: 207%; } mjx-container [size="HG"] { font-size: 249%; } mjx-container [width="full"] { width: 100%; } mjx-box { display: inline-block; } mjx-block { display: block; } mjx-itable { display: inline-table; } mjx-row { display: table-row; } mjx-row > * { display: table-cell; } mjx-mtext { display: inline-block; } mjx-mstyle { display: inline-block; } mjx-merror { display: inline-block; color: red; background-color: yellow; } mjx-mphantom { visibility: hidden; } _::-webkit-full-page-media, _:future, :root mjx-container { will-change: opacity; } mjx-assistive-mml { position: absolute !important; top: 0px; left: 0px; clip: rect(1px, 1px, 1px, 1px); padding: 1px 0px 0px 0px !important; border: 0px !important; display: block !important; width: auto !important; overflow: hidden !important; -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } mjx-assistive-mml[display="block"] { width: 100% !important; } mjx-c::before { display: block; width: 0; } .MJX-TEX { font-family: MJXZERO, MJXTEX; } .TEX-B { font-family: MJXZERO, MJXTEX-B; } .TEX-I { font-family: MJXZERO, MJXTEX-I; } .TEX-MI { font-family: MJXZERO, MJXTEX-MI; } .TEX-BI { font-family: MJXZERO, MJXTEX-BI; } .TEX-S1 { font-family: MJXZERO, MJXTEX-S1; } .TEX-S2 { font-family: MJXZERO, MJXTEX-S2; } .TEX-S3 { font-family: MJXZERO, MJXTEX-S3; } .TEX-S4 { font-family: MJXZERO, MJXTEX-S4; } .TEX-A { font-family: MJXZERO, MJXTEX-A; } .TEX-C { font-family: MJXZERO, MJXTEX-C; } .TEX-CB { font-family: MJXZERO, MJXTEX-CB; } .TEX-FR { font-family: MJXZERO, MJXTEX-FR; } .TEX-FRB { font-family: MJXZERO, MJXTEX-FRB; } .TEX-SS { font-family: MJXZERO, MJXTEX-SS; } .TEX-SSB { font-family: MJXZERO, MJXTEX-SSB; } .TEX-SSI { font-family: MJXZERO, MJXTEX-SSI; } .TEX-SC { font-family: MJXZERO, MJXTEX-SC; } .TEX-T { font-family: MJXZERO, MJXTEX-T; } .TEX-V { font-family: MJXZERO, MJXTEX-V; } .TEX-VB { font-family: MJXZERO, MJXTEX-VB; } mjx-stretchy-v mjx-c, mjx-stretchy-h mjx-c { font-family: MJXZERO, MJXTEX-S1, MJXTEX-S4, MJXTEX, MJXTEX-A ! important; } @font-face /* 0 */ { font-family: MJXZERO; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Zero.woff") format("woff"); } @font-face /* 1 */ { font-family: MJXTEX; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Regular.woff") format("woff"); } @font-face /* 2 */ { font-family: MJXTEX-B; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Bold.woff") format("woff"); } @font-face /* 3 */ { font-family: MJXTEX-I; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Math-Italic.woff") format("woff"); } @font-face /* 4 */ { font-family: MJXTEX-MI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Main-Italic.woff") format("woff"); } @font-face /* 5 */ { font-family: MJXTEX-BI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Math-BoldItalic.woff") format("woff"); } @font-face /* 6 */ { font-family: MJXTEX-S1; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size1-Regular.woff") format("woff"); } @font-face /* 7 */ { font-family: MJXTEX-S2; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size2-Regular.woff") format("woff"); } @font-face /* 8 */ { font-family: MJXTEX-S3; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size3-Regular.woff") format("woff"); } @font-face /* 9 */ { font-family: MJXTEX-S4; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Size4-Regular.woff") format("woff"); } @font-face /* 10 */ { font-family: MJXTEX-A; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_AMS-Regular.woff") format("woff"); } @font-face /* 11 */ { font-family: MJXTEX-C; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Regular.woff") format("woff"); } @font-face /* 12 */ { font-family: MJXTEX-CB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Bold.woff") format("woff"); } @font-face /* 13 */ { font-family: MJXTEX-FR; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Regular.woff") format("woff"); } @font-face /* 14 */ { font-family: MJXTEX-FRB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Bold.woff") format("woff"); } @font-face /* 15 */ { font-family: MJXTEX-SS; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Regular.woff") format("woff"); } @font-face /* 16 */ { font-family: MJXTEX-SSB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Bold.woff") format("woff"); } @font-face /* 17 */ { font-family: MJXTEX-SSI; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Italic.woff") format("woff"); } @font-face /* 18 */ { font-family: MJXTEX-SC; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Script-Regular.woff") format("woff"); } @font-face /* 19 */ { font-family: MJXTEX-T; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Typewriter-Regular.woff") format("woff"); } @font-face /* 20 */ { font-family: MJXTEX-V; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Regular.woff") format("woff"); } @font-face /* 21 */ { font-family: MJXTEX-VB; src: url("https://cdn.jsdelivr.net/npm/mathjax@3/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Bold.woff") format("woff"); } </style><script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fsrc/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.ipynb" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.ipynb.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.ipynb</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Setup"> Setup </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Download-From-Huggingface-and-Compile-for-AWS-Neuron"> Download From Huggingface and Compile for AWS-Neuron </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-Basic-Inference-Benchmarking"> Run Basic Inference Benchmarking </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Running Huggingface Roberta-Base with TensorFlow-NeuronX</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Setup"> Setup </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Download-From-Huggingface-and-Compile-for-AWS-Neuron"> Download From Huggingface and Compile for AWS-Neuron </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#Run-Basic-Inference-Benchmarking"> Run Basic Inference Benchmarking </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <style> /* CSS for nbsphinx extension */ /* remove conflicting styling from Sphinx themes */ div.nbinput.container div.prompt *, div.nboutput.container div.prompt *, div.nbinput.container div.input_area pre, div.nboutput.container div.output_area pre, div.nbinput.container div.input_area .highlight, div.nboutput.container div.output_area .highlight { border: none; padding: 0; margin: 0; box-shadow: none; } div.nbinput.container > div[class*=highlight], div.nboutput.container > div[class*=highlight] { margin: 0; } div.nbinput.container div.prompt *, div.nboutput.container div.prompt * { background: none; } div.nboutput.container div.output_area .highlight, div.nboutput.container div.output_area pre { background: unset; } div.nboutput.container div.output_area div.highlight { color: unset; /* override Pygments text color */ } /* avoid gaps between output lines */ div.nboutput.container div[class*=highlight] pre { line-height: normal; } /* input/output containers */ div.nbinput.container, div.nboutput.container { display: -webkit-flex; display: flex; align-items: flex-start; margin: 0; width: 100%; } @media (max-width: 540px) { div.nbinput.container, div.nboutput.container { flex-direction: column; } } /* input container */ div.nbinput.container { padding-top: 5px; } /* last container */ div.nblast.container { padding-bottom: 5px; } /* input prompt */ div.nbinput.container div.prompt pre { color: #307FC1; } /* output prompt */ div.nboutput.container div.prompt pre { color: #BF5B3D; } /* all prompts */ div.nbinput.container div.prompt, div.nboutput.container div.prompt { width: 4.5ex; padding-top: 5px; position: relative; user-select: none; } div.nbinput.container div.prompt > div, div.nboutput.container div.prompt > div { position: absolute; right: 0; margin-right: 0.3ex; } @media (max-width: 540px) { div.nbinput.container div.prompt, div.nboutput.container div.prompt { width: unset; text-align: left; padding: 0.4em; } div.nboutput.container div.prompt.empty { padding: 0; } div.nbinput.container div.prompt > div, div.nboutput.container div.prompt > div { position: unset; } } /* disable scrollbars on prompts */ div.nbinput.container div.prompt pre, div.nboutput.container div.prompt pre { overflow: hidden; } /* input/output area */ div.nbinput.container div.input_area, div.nboutput.container div.output_area { -webkit-flex: 1; flex: 1; overflow: auto; } @media (max-width: 540px) { div.nbinput.container div.input_area, div.nboutput.container div.output_area { width: 100%; } } /* input area */ div.nbinput.container div.input_area { border: 1px solid #e0e0e0; border-radius: 2px; /*background: #f5f5f5;*/ } /* override MathJax center alignment in output cells */ div.nboutput.container div[class*=MathJax] { text-align: left !important; } /* override sphinx.ext.imgmath center alignment in output cells */ div.nboutput.container div.math p { text-align: left; } /* standard error */ div.nboutput.container div.output_area.stderr { background: #fdd; } /* ANSI colors */ .ansi-black-fg { color: #3E424D; } .ansi-black-bg { background-color: #3E424D; } .ansi-black-intense-fg { color: #282C36; } .ansi-black-intense-bg { background-color: #282C36; } .ansi-red-fg { color: #E75C58; } .ansi-red-bg { background-color: #E75C58; } .ansi-red-intense-fg { color: #B22B31; } .ansi-red-intense-bg { background-color: #B22B31; } .ansi-green-fg { color: #00A250; } .ansi-green-bg { background-color: #00A250; } .ansi-green-intense-fg { color: #007427; } .ansi-green-intense-bg { background-color: #007427; } .ansi-yellow-fg { color: #DDB62B; } .ansi-yellow-bg { background-color: #DDB62B; } .ansi-yellow-intense-fg { color: #B27D12; } .ansi-yellow-intense-bg { background-color: #B27D12; } .ansi-blue-fg { color: #208FFB; } .ansi-blue-bg { background-color: #208FFB; } .ansi-blue-intense-fg { color: #0065CA; } .ansi-blue-intense-bg { background-color: #0065CA; } .ansi-magenta-fg { color: #D160C4; } .ansi-magenta-bg { background-color: #D160C4; } .ansi-magenta-intense-fg { color: #A03196; } .ansi-magenta-intense-bg { background-color: #A03196; } .ansi-cyan-fg { color: #60C6C8; } .ansi-cyan-bg { background-color: #60C6C8; } .ansi-cyan-intense-fg { color: #258F8F; } .ansi-cyan-intense-bg { background-color: #258F8F; } .ansi-white-fg { color: #C5C1B4; } .ansi-white-bg { background-color: #C5C1B4; } .ansi-white-intense-fg { color: #A1A6B2; } .ansi-white-intense-bg { background-color: #A1A6B2; } .ansi-default-inverse-fg { color: #FFFFFF; } .ansi-default-inverse-bg { background-color: #000000; } .ansi-bold { font-weight: bold; } .ansi-underline { text-decoration: underline; } div.nbinput.container div.input_area div[class*=highlight] > pre, div.nboutput.container div.output_area div[class*=highlight] > pre, div.nboutput.container div.output_area div[class*=highlight].math, div.nboutput.container div.output_area.rendered_html, div.nboutput.container div.output_area > div.output_javascript, div.nboutput.container div.output_area:not(.rendered_html) > img{ padding: 5px; margin: 0; } /* fix copybtn overflow problem in chromium (needed for 'sphinx_copybutton') */ div.nbinput.container div.input_area > div[class^='highlight'], div.nboutput.container div.output_area > div[class^='highlight']{ overflow-y: hidden; } /* hide copybtn icon on prompts (needed for 'sphinx_copybutton') */ .prompt .copybtn { display: none; } /* Some additional styling taken form the Jupyter notebook CSS */ .jp-RenderedHTMLCommon table, div.rendered_html table { border: none; border-collapse: collapse; border-spacing: 0; color: black; font-size: 12px; table-layout: fixed; } .jp-RenderedHTMLCommon thead, div.rendered_html thead { border-bottom: 1px solid black; vertical-align: bottom; } .jp-RenderedHTMLCommon tr, .jp-RenderedHTMLCommon th, .jp-RenderedHTMLCommon td, div.rendered_html tr, div.rendered_html th, div.rendered_html td { text-align: right; vertical-align: middle; padding: 0.5em 0.5em; line-height: normal; white-space: normal; max-width: none; border: none; } .jp-RenderedHTMLCommon th, div.rendered_html th { font-weight: bold; } .jp-RenderedHTMLCommon tbody tr:nth-child(odd), div.rendered_html tbody tr:nth-child(odd) { background: #f5f5f5; } .jp-RenderedHTMLCommon tbody tr:hover, div.rendered_html tbody tr:hover { background: rgba(66, 165, 245, 0.2); } </style> <div class="section" id="Running-Huggingface-Roberta-Base-with-TensorFlow-NeuronX"> <h1>Running Huggingface Roberta-Base with TensorFlow-NeuronX<a class="headerlink" href="#Running-Huggingface-Roberta-Base-with-TensorFlow-NeuronX" title="Permalink to this headline">#</a></h1> <p>This tutorial demonstrates how to compile the Huggingface roberta-base model and infer on a trn1.2xlarge instance with <code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>. To compile larger models like roberta-large, please consider using an inf2 instance.</p> <div class="section" id="Setup"> <h2>Setup<a class="headerlink" href="#Setup" title="Permalink to this headline">#</a></h2> <p>To run this tutorial please follow the instructions for <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/frameworks/tensorflow/tensorflow-neuronx/setup/tensorflow-neuronx-install.html">TensorFlow-NeuronX Setup</a> and the <a class="reference external" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html">Jupyter Notebook Quickstart</a> and set your kernel to “Python (tensorflow-neuronx)”.</p> <p>Next, install some additional dependencies.</p> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="k">env</span> TOKENIZERS_PARALLELISM=True #Supresses tokenizer warnings making errors easier to detect <span class="o">!</span>pip<span class="w"> </span>install<span class="w"> </span>transformers </pre></div> </div> </div> </div> <div class="section" id="Download-From-Huggingface-and-Compile-for-AWS-Neuron"> <h2>Download From Huggingface and Compile for AWS-Neuron<a class="headerlink" href="#Download-From-Huggingface-and-Compile-for-AWS-Neuron" title="Permalink to this headline">#</a></h2> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">import</span> <span class="nn">tensorflow_neuronx</span> <span class="k">as</span> <span class="nn">tfnx</span> <span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">RobertaTokenizer</span><span class="p">,</span> <span class="n">TFRobertaModel</span> <span class="kn">from</span> <span class="nn">transformers</span> <span class="kn">import</span> <span class="n">BertTokenizer</span><span class="p">,</span> <span class="n">TFBertModel</span> <span class="c1"># Create a wrapper for the roberta model that will accept inputs as a list</span> <span class="c1"># instead of a dictionary. This will allow the compiled model to be saved</span> <span class="c1"># to disk with the model.save() fucntion.</span> <span class="k">class</span> <span class="nc">RobertaWrapper</span><span class="p">(</span><span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">model</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span> <span class="o">=</span> <span class="n">model</span> <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">):</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">({</span><span class="s1">'input_ids'</span> <span class="p">:</span> <span class="n">example_inputs</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s1">'attention_mask'</span> <span class="p">:</span> <span class="n">example_inputs</span><span class="p">[</span><span class="mi">1</span><span class="p">]})</span> <span class="n">tokenizer</span> <span class="o">=</span> <span class="n">RobertaTokenizer</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="s1">'roberta-base'</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">RobertaWrapper</span><span class="p">(</span><span class="n">TFRobertaModel</span><span class="o">.</span><span class="n">from_pretrained</span><span class="p">(</span><span class="s1">'roberta-base'</span><span class="p">))</span> <span class="n">batch_size</span> <span class="o">=</span> <span class="mi">16</span> <span class="c1"># create example inputs with a batch size of 16</span> <span class="n">text</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"Paris is the &lt;mask&gt; of France."</span><span class="p">]</span> <span class="o">*</span> <span class="n">batch_size</span> <span class="n">encoded_input</span> <span class="o">=</span> <span class="n">tokenizer</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">return_tensors</span><span class="o">=</span><span class="s1">'tf'</span><span class="p">,</span> <span class="n">padding</span><span class="o">=</span><span class="s1">'max_length'</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="mi">64</span><span class="p">)</span> <span class="c1"># turn inputs into a list</span> <span class="n">example_input</span> <span class="o">=</span> <span class="p">[</span><span class="n">encoded_input</span><span class="p">[</span><span class="s1">'input_ids'</span><span class="p">],</span> <span class="n">encoded_input</span><span class="p">[</span><span class="s1">'attention_mask'</span><span class="p">]]</span> <span class="c1">#compile</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">tfnx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example_input</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Running on neuron:"</span><span class="p">,</span> <span class="n">model_neuron</span><span class="p">(</span><span class="n">example_input</span><span class="p">))</span> <span class="c1"># save the model to disk to save recompilation time for next usage</span> <span class="n">model_neuron</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s1">'./roberta-neuron-b16'</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="Run-Basic-Inference-Benchmarking"> <h2>Run Basic Inference Benchmarking<a class="headerlink" href="#Run-Basic-Inference-Benchmarking" title="Permalink to this headline">#</a></h2> <div class="nbinput nblast docutils container"> <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]: </pre></div> </div> <div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> <span class="kn">import</span> <span class="nn">concurrent.futures</span> <span class="kn">import</span> <span class="nn">time</span> <span class="n">reloaded_neuron_model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">load_model</span><span class="p">(</span><span class="s1">'./roberta-neuron-b16'</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s2">"Reloaded model running on neuron:"</span><span class="p">,</span> <span class="n">reloaded_neuron_model</span><span class="p">(</span><span class="n">example_input</span><span class="p">))</span> <span class="n">num_threads</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">num_inferences</span> <span class="o">=</span> <span class="mi">1000</span> <span class="n">latency_list</span> <span class="o">=</span> <span class="p">[]</span> <span class="k">def</span> <span class="nf">inference_with_latency_calculation</span><span class="p">(</span><span class="n">example_input</span><span class="p">):</span> <span class="k">global</span> <span class="n">latency_list</span> <span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="n">result</span> <span class="o">=</span> <span class="n">reloaded_neuron_model</span><span class="p">(</span><span class="n">example_input</span><span class="p">)</span> <span class="n">end</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="n">latency_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">end</span><span class="o">-</span><span class="n">start</span><span class="p">)</span> <span class="o">*</span> <span class="mi">1000</span><span class="p">)</span> <span class="k">return</span> <span class="n">result</span> <span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="k">with</span> <span class="n">concurrent</span><span class="o">.</span><span class="n">futures</span><span class="o">.</span><span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="o">=</span><span class="n">num_threads</span><span class="p">)</span> <span class="k">as</span> <span class="n">executor</span><span class="p">:</span> <span class="n">futures</span> <span class="o">=</span> <span class="p">[]</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">num_inferences</span><span class="p">):</span> <span class="n">futures</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">executor</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">inference_with_latency_calculation</span><span class="p">,</span> <span class="n">example_input</span><span class="p">))</span> <span class="k">for</span> <span class="n">future</span> <span class="ow">in</span> <span class="n">concurrent</span><span class="o">.</span><span class="n">futures</span><span class="o">.</span><span class="n">as_completed</span><span class="p">(</span><span class="n">futures</span><span class="p">):</span> <span class="n">get_result</span> <span class="o">=</span> <span class="n">future</span><span class="o">.</span><span class="n">result</span><span class="p">()</span> <span class="n">end</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="n">total_time</span> <span class="o">=</span> <span class="n">end</span> <span class="o">-</span> <span class="n">start</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Throughput was </span><span class="si">{</span><span class="p">(</span><span class="n">num_inferences</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">batch_size</span><span class="p">)</span><span class="o">/</span><span class="n">total_time</span><span class="si">}</span><span class="s2"> samples per second."</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Latency p50 was </span><span class="si">{</span><span class="n">np</span><span class="o">.</span><span class="n">percentile</span><span class="p">(</span><span class="n">latency_list</span><span class="p">,</span><span class="w"> </span><span class="mi">50</span><span class="p">)</span><span class="si">}</span><span class="s2"> ms"</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Latency p90 was </span><span class="si">{</span><span class="n">np</span><span class="o">.</span><span class="n">percentile</span><span class="p">(</span><span class="n">latency_list</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span><span class="p">)</span><span class="si">}</span><span class="s2"> ms"</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Latency p99 was </span><span class="si">{</span><span class="n">np</span><span class="o">.</span><span class="n">percentile</span><span class="p">(</span><span class="n">latency_list</span><span class="p">,</span><span class="w"> </span><span class="mi">99</span><span class="p">)</span><span class="si">}</span><span class="s2"> ms"</span><span class="p">)</span> </pre></div> </div> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:14.188Z
API Reference Guide (tensorflow-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html
# API Reference Guide (tensorflow-neuronx) — AWS Neuron Documentation previous Using NEURON\_RT\_VISIBLE\_CORES with TensorFlow Serving
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>API Reference Guide (tensorflow-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow 2.x (tensorflow-neuronx) Tracing API" href="tfneuronx-python-tracing-api.html"> <link rel="prev" title="Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving" href="tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuronx/api-reference-guide", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx/api-reference-guide.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>API Reference Guide (tensorflow-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="api-reference-guide-tensorflow-neuronx"> <h1>API Reference Guide (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)<a class="headerlink" href="#api-reference-guide-tensorflow-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="tfneuronx-python-tracing-api.html#tfneuronx-ref-neuron-tracing-api"><span class="std std-ref">TensorFlow 2.x (tensorflow-neuronx) Tracing API</span></a></p></li> <li><p><a class="reference internal" href="tf-neuronx-auto-replication-api.html#tf-neuronx-ref-auto-replication-python-api"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuronx) Auto Multicore Replication (Experimental)</span></a></p></li> <li><p><a class="reference internal" href="tfnx-analyze-model-api.html#tf-neuronx-ref-analyze-model-api"><span class="std std-ref">TensorFlow 2.x (tensorflow-neuronx) analyze_model API</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving</p> </div> </a> <a class="right-next" id="next-link" href="tfneuronx-python-tracing-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Tracing API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:14.567Z
Tutorials (tensorflow-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html
# Tutorials (tensorflow-neuronx) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.rst) - [.rst](../../../../_sources/frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.rst.txt) ## Tutorials (tensorflow-neuronx) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Tutorials (`tensorflow-neuronx`)[#](#tutorials-tensorflow-neuronx "Permalink to this headline") - HuggingFace Roberta-Base [\[html\]](../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.ipynb) - [Using NEURON\_RT\_VISIBLE\_CORES with TensorFlow Serving](tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html#tensorflow-servingx-neuronrt-visible-cores) Note To use Jupyter Notebook see: - [Jupyter Notebook QuickStart](../../../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting) - [Running Jupyter Notebook as script](../../../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Tutorials (tensorflow-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Running Huggingface Roberta-Base with TensorFlow-NeuronX" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> <link rel="prev" title="Inference on Inf2 &amp; Trn1/Trn1n (tensorflow-neuronx)" href="../../tensorflow-neuronx-inference.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Tutorials (tensorflow-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="tutorials-tensorflow-neuronx"> <span id="inference-tensorflow-neuronx-tutorials"></span><h1>Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)<a class="headerlink" href="#tutorials-tensorflow-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p>HuggingFace Roberta-Base <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.ipynb">[notebook]</a></p></li> <li><p><a class="reference internal" href="tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html#tensorflow-servingx-neuronrt-visible-cores"><span class="std std-ref">Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving</span></a></p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p>To use Jupyter Notebook see:</p> <ul class="simple"> <li><p><a class="reference internal" href="../../../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p><a class="reference internal" href="../../../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../tensorflow-neuronx-inference.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Inference on Inf2 &amp; Trn1/Trn1n (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Running Huggingface Roberta-Base with TensorFlow-NeuronX</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:14.840Z
TensorFlow 2.x (tensorflow-neuronx) Tracing API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html
# TensorFlow 2.x (tensorflow-neuronx) Tracing API — AWS Neuron Documentation Toggle in-page Table of Contents Contents - [Method](#method) - [Description](#description) - [Arguments](#arguments) - [Special Flags](#special-flags) - [Returns](#returns) - [Example Usage](#example-usage) - [Example Usage with Manual Device Placement Using subgraph\_builder\_function](#example-usage-with-manual-device-placement-using-subgraph-builder-function) ## Contents - [Method](#method) - [Description](#description) - [Arguments](#arguments) - [Special Flags](#special-flags) - [Returns](#returns) - [Example Usage](#example-usage) - [Example Usage with Manual Device Placement Using subgraph\_builder\_function](#example-usage-with-manual-device-placement-using-subgraph-builder-function) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## TensorFlow 2.x (`tensorflow-neuronx`) Tracing API[#](#tensorflow-2-x-tensorflow-neuronx-tracing-api "Permalink to this headline") The Neuron tracing API enables tracing TensorFlow 2.x models for deployment on trn1 and inf2 AWS machine learning accelerators. ## Method[#](#method "Permalink to this headline") `tensorflow_neuronx.trace` ## Description[#](#description "Permalink to this headline") Trace a `keras.Model` or a Python callable that can be decorated by `tf.function`, and return an AWS-Neuron-optimized `keras.Model` that can execute on trn1 and inf2 AWS machine learning accelerators. Tracing is ideal for `keras.Model` that accepts a list of `tf.Tensor` objects and returns a list of `tf.Tensor` objects. It is expected that users will provide example inputs, and the `trace` function will execute `func` symbolically and convert it to a `keras.Model`. The returned `keras.Model` will support inference only. Attributes or variables held by the original function or `keras.Model` will be dropped. The returned `keras.Model` can be exported as SavedModel and served using TensorFlow Serving. Please see tensorflow-serving for more information about exporting to saved model and serving using TensorFlow Serving. The returned `keras.Model` has an `.on_neuron_ratio` attribute which shows the percentage of ops mapped to neuron hardware. This calculation ignores PlaceholerOp, IdentityOp, ReadVariableOp and NoOp. Options can be passed to Neuron compiler via the environment variable `NEURON_CC_FLAGS`. For example, the syntax `env NEURON_CC_FLAGS="--workdir ./artifacts"` directs the Neuron compiler to dump artifacts in the artifacts directory for debugging. See [Neuron Compiler CLI Reference Guide (neuronx-cc)](../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) for more information about compiler options. ## Arguments[#](#arguments "Permalink to this headline") - **func:** The `keras.Model` or function to be traced. - **example\_inputs:** A `tf.Tensor` or a tuple/list/dict of `tf.Tensor` objects for tracing the function. When `example_inputs` is a `tf.Tensor` or a list of `tf.Tensor` objects, we expect `func` to have calling signature `func(example_inputs)`. Otherwise, the expectation is that inference on `func` is done by calling `func(*example_inputs)` when `example_inputs` is a `tuple`, or `func(**example_inputs)` when `example_inputs` is a `dict`. The case where `func` accepts mixed positional and keyword arguments is currently unsupported. - **subgraph\_builder\_function:** (Optional) A callable with signature `subgraph_builder_function(node : NodeDef) -> bool` (`NodeDef` is defined in tensorflow/core/framework/node\_def.proto) that is used as a call-back function to determine which part of the tensorflow GraphDef given by tracing `func` will be placed on Machine Learning Accelerators. If `subgraph_builder_function` is not provided, then `trace` will automatically place operations on Machine Learning Accelerators or on CPU to maximize the execution efficiency. If it is provided, and `subgraph_builder_function(node)` returns `True`, and placing `node` on Machine Learning Accelerators will not cause deadlocks during execution, then `trace` will place `node` on Machine Learning Accelerators. If `subgraph_builder_function(node)` returns `False`, then `trace` will place `node` on CPU. ## Special Flags[#](#special-flags "Permalink to this headline") These are flags that get passed directly to the Neuron tracing API (rather than the Neuron Compiler). The flags are still passed via the environment variable `NEURON_CC_FLAGS`. - **workdir:** example usage - `NEURON_CC_FLAGS='--workdir ./artifacts'` will create a folder named artifacts in the current directory and save artifacts that can be used for debug. - **dynamic-batch-size:** example usage - `NEURON_CC_FLAGS='--dynamic-batch-size'` A flag to allow Neuron graphs to consume variable sized batches of data. Dynamic sizing is restricted to the 0th dimension of a tensor. - **extract-weights (EXPERIMENTAL):** example usage - `NEURON_CC_FLAGS='--extract-weights trn1.2xlarge'` will reduce the compiled model’s protobuf size by taking the weights out of the protobuf. Useful for compiling large models that would exceed the 2GB protobuf size limit. This feature is experimental. Model performance is not guaranteed and the flag does not work in combination with `--neuroncore-pipeline-cores`, `--dynamic-batch-size`, models with multiple NEFFs, and models that are 16GB or greater. Compiles models for different neuron instances depending on the instance type passed. Supports all trn1 and inf2 instance types except for trn1n. ## Returns[#](#returns "Permalink to this headline") - An AWS-Neuron-optimized `keras.Model`. ## Example Usage[#](#example-usage "Permalink to this headline") ``` import tensorflow as tf import tensorflow_neuronx as tfnx input0 = tf.keras.layers.Input(3) dense0 = tf.keras.layers.Dense(3)(input0) model = tf.keras.Model(inputs=[input0], outputs=[dense0]) example_inputs = tf.random.uniform([1, 3]) model_neuron = tfnx.trace(model, example_inputs) # trace # check to see how much of the model was compiled successfully print(model_neuron.on_neuron_ratio) model_dir = './model_neuron' model_neuron.save(model_dir) model_neuron_reloaded = tf.keras.models.load_model(model_dir) ``` ## Example Usage with Manual Device Placement Using subgraph\_builder\_function[#](#example-usage-with-manual-device-placement-using-subgraph-builder-function "Permalink to this headline") ``` import tensorflow as tf import tensorflow_neuronx as tfnx input0 = tf.keras.layers.Input(3) dense0 = tf.keras.layers.Dense(3)(input0) reshape0 = tf.keras.layers.Reshape([1, 3])(dense0) output0 = tf.keras.layers.Dense(2)(reshape0) model = tf.keras.Model(inputs=[input0], outputs=[output0]) example_inputs = tf.random.uniform([1, 3]) def subgraph_builder_function(node): return node.op == 'MatMul' model_neuron = tfnx.trace( model, example_inputs, subgraph_builder_function=subgraph_builder_function, ) ``` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow 2.x (tensorflow-neuronx) Tracing API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow Neuron (tensorflow-neuronx) Auto Multicore Replication (Experimental)" href="tf-neuronx-auto-replication-api.html"> <link rel="prev" title="API Reference Guide (tensorflow-neuronx)" href="api-reference-guide.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#special-flags"> Special Flags </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage-with-manual-device-placement-using-subgraph-builder-function"> Example Usage with Manual Device Placement Using <cite> subgraph_builder_function </cite> </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow 2.x (tensorflow-neuronx) Tracing API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#special-flags"> Special Flags </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage-with-manual-device-placement-using-subgraph-builder-function"> Example Usage with Manual Device Placement Using <cite> subgraph_builder_function </cite> </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="tensorflow-2-x-tensorflow-neuronx-tracing-api"> <span id="tfneuronx-ref-neuron-tracing-api"></span><h1>TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Tracing API<a class="headerlink" href="#tensorflow-2-x-tensorflow-neuronx-tracing-api" title="Permalink to this headline">#</a></h1> <p>The Neuron tracing API enables tracing TensorFlow 2.x models for deployment on trn1 and inf2 AWS machine learning accelerators.</p> <div class="section" id="method"> <h2>Method<a class="headerlink" href="#method" title="Permalink to this headline">#</a></h2> <p><code class="docutils literal notranslate"><span class="pre">tensorflow_neuronx.trace</span></code></p> </div> <div class="section" id="description"> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2> <p>Trace a <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or a Python callable that can be decorated by <code class="docutils literal notranslate"><span class="pre">tf.function</span></code>, and return an AWS-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> that can execute on trn1 and inf2 AWS machine learning accelerators. Tracing is ideal for <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> that accepts a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects and returns a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects. It is expected that users will provide example inputs, and the <code class="docutils literal notranslate"><span class="pre">trace</span></code> function will execute <code class="docutils literal notranslate"><span class="pre">func</span></code> symbolically and convert it to a <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code>.</p> <p>The returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will support inference only. Attributes or variables held by the original function or <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will be dropped.</p> <p>The returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> can be exported as SavedModel and served using TensorFlow Serving. Please see <span class="xref std std-ref">tensorflow-serving</span> for more information about exporting to saved model and serving using TensorFlow Serving.</p> <p>The returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> has an <code class="docutils literal notranslate"><span class="pre">.on_neuron_ratio</span></code> attribute which shows the percentage of ops mapped to neuron hardware. This calculation ignores PlaceholerOp, IdentityOp, ReadVariableOp and NoOp.</p> <p>Options can be passed to Neuron compiler via the environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code>. For example, the syntax <code class="docutils literal notranslate"><span class="pre">env</span> <span class="pre">NEURON_CC_FLAGS="--workdir</span> <span class="pre">./artifacts"</span></code> directs the Neuron compiler to dump artifacts in the artifacts directory for debugging. See <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">Neuron Compiler CLI Reference Guide (neuronx-cc)</span></a> for more information about compiler options.</p> </div> <div class="section" id="arguments"> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">#</a></h2> <ul> <li><p><strong>func:</strong> The <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or function to be traced.</p></li> <li><p><strong>example_inputs:</strong> A <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a tuple/list/dict of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects for tracing the function. When <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects, we expect <code class="docutils literal notranslate"><span class="pre">func</span></code> to have calling signature <code class="docutils literal notranslate"><span class="pre">func(example_inputs)</span></code>. Otherwise, the expectation is that inference on <code class="docutils literal notranslate"><span class="pre">func</span></code> is done by calling <code class="docutils literal notranslate"><span class="pre">func(*example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tuple</span></code>, or <code class="docutils literal notranslate"><span class="pre">func(**example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">dict</span></code>. The case where <code class="docutils literal notranslate"><span class="pre">func</span></code> accepts mixed positional and keyword arguments is currently unsupported.</p></li> <li><p><strong>subgraph_builder_function:</strong> (Optional) A callable with signature</p> <p><code class="docutils literal notranslate"><span class="pre">subgraph_builder_function(node</span> <span class="pre">:</span> <span class="pre">NodeDef)</span> <span class="pre">-&gt;</span> <span class="pre">bool</span></code> (<code class="docutils literal notranslate"><span class="pre">NodeDef</span></code> is defined in tensorflow/core/framework/node_def.proto)</p> <p>that is used as a call-back function to determine which part of the tensorflow GraphDef given by tracing <code class="docutils literal notranslate"><span class="pre">func</span></code> will be placed on Machine Learning Accelerators.</p> <p>If <code class="docutils literal notranslate"><span class="pre">subgraph_builder_function</span></code> is not provided, then <code class="docutils literal notranslate"><span class="pre">trace</span></code> will automatically place operations on Machine Learning Accelerators or on CPU to maximize the execution efficiency.</p> <p>If it is provided, and <code class="docutils literal notranslate"><span class="pre">subgraph_builder_function(node)</span></code> returns <code class="docutils literal notranslate"><span class="pre">True</span></code>, and placing <code class="docutils literal notranslate"><span class="pre">node</span></code> on Machine Learning Accelerators will not cause deadlocks during execution, then <code class="docutils literal notranslate"><span class="pre">trace</span></code> will place <code class="docutils literal notranslate"><span class="pre">node</span></code> on Machine Learning Accelerators. If <code class="docutils literal notranslate"><span class="pre">subgraph_builder_function(node)</span></code> returns <code class="docutils literal notranslate"><span class="pre">False</span></code>, then <code class="docutils literal notranslate"><span class="pre">trace</span></code> will place <code class="docutils literal notranslate"><span class="pre">node</span></code> on CPU.</p> </li> </ul> </div> <div class="section" id="special-flags"> <span id="tensorflow-neuronx-special-flags"></span><h2>Special Flags<a class="headerlink" href="#special-flags" title="Permalink to this headline">#</a></h2> <p>These are flags that get passed directly to the Neuron tracing API (rather than the Neuron Compiler). The flags are still passed via the environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code>.</p> <ul class="simple"> <li><p><strong>workdir:</strong> example usage - <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--workdir</span> <span class="pre">./artifacts'</span></code> will create a folder named artifacts in the current directory and save artifacts that can be used for debug.</p></li> <li><p><strong>dynamic-batch-size:</strong> example usage - <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--dynamic-batch-size'</span></code> A flag to allow Neuron graphs to consume variable sized batches of data. Dynamic sizing is restricted to the 0th dimension of a tensor.</p></li> <li><p><strong>extract-weights (EXPERIMENTAL):</strong> example usage - <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--extract-weights</span> <span class="pre">trn1.2xlarge'</span></code> will reduce the compiled model’s protobuf size by taking the weights out of the protobuf. Useful for compiling large models that would exceed the 2GB protobuf size limit. This feature is experimental. Model performance is not guaranteed and the flag does not work in combination with <code class="docutils literal notranslate"><span class="pre">--neuroncore-pipeline-cores</span></code>, <code class="docutils literal notranslate"><span class="pre">--dynamic-batch-size</span></code>, models with multiple NEFFs, and models that are 16GB or greater. Compiles models for different neuron instances depending on the instance type passed. Supports all trn1 and inf2 instance types except for trn1n.</p></li> </ul> </div> <div class="section" id="returns"> <h2>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p>An AWS-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code>.</p></li> </ul> </div> <div class="section" id="example-usage"> <h2>Example Usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">#</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">import</span> <span class="nn">tensorflow_neuronx</span> <span class="k">as</span> <span class="nn">tfnx</span> <span class="n">input0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Input</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="n">dense0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">3</span><span class="p">)(</span><span class="n">input0</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">Model</span><span class="p">(</span><span class="n">inputs</span><span class="o">=</span><span class="p">[</span><span class="n">input0</span><span class="p">],</span> <span class="n">outputs</span><span class="o">=</span><span class="p">[</span><span class="n">dense0</span><span class="p">])</span> <span class="n">example_inputs</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">tfnx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">)</span> <span class="c1"># trace</span> <span class="c1"># check to see how much of the model was compiled successfully</span> <span class="nb">print</span><span class="p">(</span><span class="n">model_neuron</span><span class="o">.</span><span class="n">on_neuron_ratio</span><span class="p">)</span> <span class="n">model_dir</span> <span class="o">=</span> <span class="s1">'./model_neuron'</span> <span class="n">model_neuron</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">model_dir</span><span class="p">)</span> <span class="n">model_neuron_reloaded</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">load_model</span><span class="p">(</span><span class="n">model_dir</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="example-usage-with-manual-device-placement-using-subgraph-builder-function"> <h2>Example Usage with Manual Device Placement Using <cite>subgraph_builder_function</cite><a class="headerlink" href="#example-usage-with-manual-device-placement-using-subgraph-builder-function" title="Permalink to this headline">#</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">import</span> <span class="nn">tensorflow_neuronx</span> <span class="k">as</span> <span class="nn">tfnx</span> <span class="n">input0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Input</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="n">dense0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">3</span><span class="p">)(</span><span class="n">input0</span><span class="p">)</span> <span class="n">reshape0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Reshape</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])(</span><span class="n">dense0</span><span class="p">)</span> <span class="n">output0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">2</span><span class="p">)(</span><span class="n">reshape0</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">Model</span><span class="p">(</span><span class="n">inputs</span><span class="o">=</span><span class="p">[</span><span class="n">input0</span><span class="p">],</span> <span class="n">outputs</span><span class="o">=</span><span class="p">[</span><span class="n">output0</span><span class="p">])</span> <span class="n">example_inputs</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="k">def</span> <span class="nf">subgraph_builder_function</span><span class="p">(</span><span class="n">node</span><span class="p">):</span> <span class="k">return</span> <span class="n">node</span><span class="o">.</span><span class="n">op</span> <span class="o">==</span> <span class="s1">'MatMul'</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">tfnx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span> <span class="n">model</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">,</span> <span class="n">subgraph_builder_function</span><span class="o">=</span><span class="n">subgraph_builder_function</span><span class="p">,</span> <span class="p">)</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-reference-guide.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">API Reference Guide (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="tf-neuronx-auto-replication-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Auto Multicore Replication (Experimental)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:15.195Z
TensorFlow Neuron (tensorflow-neuronx) Auto Multicore Replication (Experimental) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html
# TensorFlow Neuron (tensorflow-neuronx) Auto Multicore Replication (Experimental) — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## TensorFlow Neuron (`tensorflow-neuronx`) Auto Multicore Replication (Experimental)[#](#tensorflow-neuron-tensorflow-neuronx-auto-multicore-replication-experimental "Permalink to this headline") The Neuron auto multicore replication Python API enables modifying TensorFlow 2.x models trace by `` `tensorflow_neuronx.trace` `` so that they can be automatically replicated across multiple cores. Table of contents - [TensorFlow Neuron TF 2.x (`tensorflow-neuron TF2.x`) Auto Multicore Replication Python API (Experimental)](#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental) - [TensorFlow Neuron TF2.x (`tensorflow-neuronx TF2.x`) Auto Multicore Replication CLI (Experimental)](#tensorflow-neuron-tf2-x-tensorflow-neuronx-tf2-x-auto-multicore-replication-cli-experimental) ## [TensorFlow Neuron TF 2.x (`tensorflow-neuron TF2.x`) Auto Multicore Replication Python API (Experimental)](#id3)[#](#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental "Permalink to this headline") ### Method[#](#method "Permalink to this headline") `tensorflow.neuron.auto_multicore` on models traced by `tensorflow_neuronx.trace` ### Description[#](#description "Permalink to this headline") Converts an existing AWS-Neuron-optimized `keras.Model` and returns an auto-replication tagged AWS-Multicore-Neuron-optimized `keras.Model` that can execute on AWS Machine Learning Accelerators. Like the traced model, the returned `keras.Model` will support inference only. Attributes or variables held by the original function or `keras.Model` will be dropped. The auto model replication feature in TensorFlow-Neuron enables you to create a model once and the model parallel replication would happen automatically. The desired number of cores can be less than the total available NeuronCores on an trn1 or inf2 instance but not less than 1. This reduces framework memory usage as you are not loading the same model multiple times manually. Calls to the returned model will execute the call on each core in a round-robin fashion. The returned `keras.Model` can be exported as SavedModel and served using TensorFlow Serving. Please see tensorflow-serving for more information about exporting to saved model and serving using TensorFlow Serving. Note that the automatic replication will only work on models compiled with pipeline size 1: via `--neuroncore-pipeline-cores=1`. If auto replication is not enabled, the model will default to replicate on up to 4 cores. See [Neuron Compiler CLI Reference Guide (neuronx-cc)](../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide) for more information about compiler options. ### Arguments[#](#arguments "Permalink to this headline") - **func:** The `keras.Model` or function to be traced. - **example\_inputs:** A `tf.Tensor` or a tuple/list/dict of `tf.Tensor` objects for tracing the function. When `example_inputs` is a `tf.Tensor` or a list of `tf.Tensor` objects, we expect `func` to have calling signature `func(example_inputs)`. Otherwise, the expectation is that inference on `func` is done by calling `func(*example_inputs)` when `example_inputs` is a `tuple`, or `func(**example_inputs)` when `example_inputs` is a `dict`. The case where `func` accepts mixed positional and keyword arguments is currently unsupported. - **num\_cores:** The desired number of cores where the model will be automatically replicated across ### Returns[#](#returns "Permalink to this headline") - An AWS-Multicore-Neuron-optimized `keras.Model`. ### Example Python API Usage for TF2.x traced models:[#](#example-python-api-usage-for-tf2-x-traced-models "Permalink to this headline") ``` import tensorflow as tf import tensorflow.neuron as tfn import tensorflow_neuronx as tfnx input0 = tf.keras.layers.Input(3) dense0 = tf.keras.layers.Dense(3)(input0) inputs = [input0] outputs = [dense0] model = tf.keras.Model(inputs=inputs, outputs=outputs) input0_tensor = tf.random.uniform([1, 3]) model_neuron = tfnx.trace(model, input0_tensor) # a trn1.2xlarge has 2 neuron cores num_cores = 2 multicore_model = tfn.auto_multicore(model_neuron, input0_tensor, num_cores=num_cores) multicore_model(input0_tensor) ``` ### Example Python API Usage for TF2.x saved models:[#](#example-python-api-usage-for-tf2-x-saved-models "Permalink to this headline") ``` from tensorflow.python import saved_model input0_tensor = tf.random.uniform([1, 3]) num_cores = 4 reload_model = saved_model.load(model_dir) multicore_model = tfn.auto_multicore(reload_model, input0_tensor, num_cores=num_cores) ``` ## [TensorFlow Neuron TF2.x (`tensorflow-neuronx TF2.x`) Auto Multicore Replication CLI (Experimental)](#id4)[#](#tensorflow-neuron-tf2-x-tensorflow-neuronx-tf2-x-auto-multicore-replication-cli-experimental "Permalink to this headline") The Neuron auto multicore replication CLI enables modifying Tensorflow 2.x traced saved models so that they can be automatically replicated across multiple cores. By performing this call on Tensorflow Saved Models, we can support Tensorflow-Serving without significant modifications to the code. ### Method[#](#id1 "Permalink to this headline") `tf-neuron-auto-multicore MODEL_DIR --num_cores NUM_CORES --new_model_dir NEW_MODEL_DIR` ### Arguments[#](#id2 "Permalink to this headline") - **MODEL\_DIR:** The directory of a saved AWS-Neuron-optimized `keras.Model`. - **NUM\_CORES:** The desired number of cores where the model will be automatically replicated across - **NEW\_MODEL\_DIR:** The directory of where the AWS-Multicore-Neuron-optimized `keras.Model` will be saved ### Example CLI Usage for Tensorflow-Serving saved models:[#](#example-cli-usage-for-tensorflow-serving-saved-models "Permalink to this headline") ``` tf-neuron-auto-multicore ./resnet --num_cores 8 --new_model_dir ./modified_resnet ``` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow Neuron (tensorflow-neuronx) Auto Multicore Replication (Experimental) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow 2.x (tensorflow-neuronx) analyze_model API" href="tfnx-analyze-model-api.html"> <link rel="prev" title="TensorFlow 2.x (tensorflow-neuronx) Tracing API" href="tfneuronx-python-tracing-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental"> TensorFlow Neuron TF 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> TF2.x </span> </code> ) Auto Multicore Replication Python API (Experimental) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-python-api-usage-for-tf2-x-traced-models"> Example Python API Usage for TF2.x traced models: </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-python-api-usage-for-tf2-x-saved-models"> Example Python API Usage for TF2.x saved models: </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-tf2-x-tensorflow-neuronx-tf2-x-auto-multicore-replication-cli-experimental"> TensorFlow Neuron TF2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> <span class="pre"> TF2.x </span> </code> ) Auto Multicore Replication CLI (Experimental) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Method </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> Arguments </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-cli-usage-for-tensorflow-serving-saved-models"> Example CLI Usage for Tensorflow-Serving saved models: </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow Neuron (tensorflow-neuronx) Auto Multicore Replication (Experimental)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental"> TensorFlow Neuron TF 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> TF2.x </span> </code> ) Auto Multicore Replication Python API (Experimental) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-python-api-usage-for-tf2-x-traced-models"> Example Python API Usage for TF2.x traced models: </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-python-api-usage-for-tf2-x-saved-models"> Example Python API Usage for TF2.x saved models: </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-tf2-x-tensorflow-neuronx-tf2-x-auto-multicore-replication-cli-experimental"> TensorFlow Neuron TF2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> <span class="pre"> TF2.x </span> </code> ) Auto Multicore Replication CLI (Experimental) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Method </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> Arguments </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-cli-usage-for-tensorflow-serving-saved-models"> Example CLI Usage for Tensorflow-Serving saved models: </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="tensorflow-neuron-tensorflow-neuronx-auto-multicore-replication-experimental"> <span id="tf-neuronx-ref-auto-replication-python-api"></span><h1>TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Auto Multicore Replication (Experimental)<a class="headerlink" href="#tensorflow-neuron-tensorflow-neuronx-auto-multicore-replication-experimental" title="Permalink to this headline">#</a></h1> <p>The Neuron auto multicore replication Python API enables modifying TensorFlow 2.x models trace by <code class="docutils literal notranslate"><span class="pre">`tensorflow_neuronx.trace`</span></code> so that they can be automatically replicated across multiple cores.</p> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental" id="id3">TensorFlow Neuron TF 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">TF2.x</span></code>) Auto Multicore Replication Python API (Experimental)</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-tf2-x-tensorflow-neuronx-tf2-x-auto-multicore-replication-cli-experimental" id="id4">TensorFlow Neuron TF2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span> <span class="pre">TF2.x</span></code>) Auto Multicore Replication CLI (Experimental)</a></p></li> </ul> </div> <div class="section" id="tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental"> <h2><a class="toc-backref" href="#id3">TensorFlow Neuron TF 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">TF2.x</span></code>) Auto Multicore Replication Python API (Experimental)</a><a class="headerlink" href="#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental" title="Permalink to this headline">#</a></h2> <div class="section" id="method"> <h3>Method<a class="headerlink" href="#method" title="Permalink to this headline">#</a></h3> <p><code class="docutils literal notranslate"><span class="pre">tensorflow.neuron.auto_multicore</span></code> on models traced by <code class="docutils literal notranslate"><span class="pre">tensorflow_neuronx.trace</span></code></p> </div> <div class="section" id="description"> <h3>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h3> <p>Converts an existing AWS-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> and returns an auto-replication tagged AWS-Multicore-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> that can execute on AWS Machine Learning Accelerators. Like the traced model, the returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will support inference only. Attributes or variables held by the original function or <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will be dropped.</p> <p>The auto model replication feature in TensorFlow-Neuron enables you to create a model once and the model parallel replication would happen automatically. The desired number of cores can be less than the total available NeuronCores on an trn1 or inf2 instance but not less than 1. This reduces framework memory usage as you are not loading the same model multiple times manually. Calls to the returned model will execute the call on each core in a round-robin fashion.</p> <p>The returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> can be exported as SavedModel and served using TensorFlow Serving. Please see <span class="xref std std-ref">tensorflow-serving</span> for more information about exporting to saved model and serving using TensorFlow Serving.</p> <p>Note that the automatic replication will only work on models compiled with pipeline size 1: via <code class="docutils literal notranslate"><span class="pre">--neuroncore-pipeline-cores=1</span></code>. If auto replication is not enabled, the model will default to replicate on up to 4 cores.</p> <p>See <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html#neuron-compiler-cli-reference-guide"><span class="std std-ref">Neuron Compiler CLI Reference Guide (neuronx-cc)</span></a> for more information about compiler options.</p> </div> <div class="section" id="arguments"> <h3>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p><strong>func:</strong> The <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or function to be traced.</p></li> <li><p><strong>example_inputs:</strong> A <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a tuple/list/dict of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects for tracing the function. When <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects, we expect <code class="docutils literal notranslate"><span class="pre">func</span></code> to have calling signature <code class="docutils literal notranslate"><span class="pre">func(example_inputs)</span></code>. Otherwise, the expectation is that inference on <code class="docutils literal notranslate"><span class="pre">func</span></code> is done by calling <code class="docutils literal notranslate"><span class="pre">func(*example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tuple</span></code>, or <code class="docutils literal notranslate"><span class="pre">func(**example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">dict</span></code>. The case where <code class="docutils literal notranslate"><span class="pre">func</span></code> accepts mixed positional and keyword arguments is currently unsupported.</p></li> <li><p><strong>num_cores:</strong> The desired number of cores where the model will be automatically replicated across</p></li> </ul> </div> <div class="section" id="returns"> <h3>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>An AWS-Multicore-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code>.</p></li> </ul> </div> <div class="section" id="example-python-api-usage-for-tf2-x-traced-models"> <h3>Example Python API Usage for TF2.x traced models:<a class="headerlink" href="#example-python-api-usage-for-tf2-x-traced-models" title="Permalink to this headline">#</a></h3> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">import</span> <span class="nn">tensorflow.neuron</span> <span class="k">as</span> <span class="nn">tfn</span> <span class="kn">import</span> <span class="nn">tensorflow_neuronx</span> <span class="k">as</span> <span class="nn">tfnx</span> <span class="n">input0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Input</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="n">dense0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">3</span><span class="p">)(</span><span class="n">input0</span><span class="p">)</span> <span class="n">inputs</span> <span class="o">=</span> <span class="p">[</span><span class="n">input0</span><span class="p">]</span> <span class="n">outputs</span> <span class="o">=</span> <span class="p">[</span><span class="n">dense0</span><span class="p">]</span> <span class="n">model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">Model</span><span class="p">(</span><span class="n">inputs</span><span class="o">=</span><span class="n">inputs</span><span class="p">,</span> <span class="n">outputs</span><span class="o">=</span><span class="n">outputs</span><span class="p">)</span> <span class="n">input0_tensor</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">tfnx</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">input0_tensor</span><span class="p">)</span> <span class="c1"># a trn1.2xlarge has 2 neuron cores</span> <span class="n">num_cores</span> <span class="o">=</span> <span class="mi">2</span> <span class="n">multicore_model</span> <span class="o">=</span> <span class="n">tfn</span><span class="o">.</span><span class="n">auto_multicore</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">input0_tensor</span><span class="p">,</span> <span class="n">num_cores</span><span class="o">=</span><span class="n">num_cores</span><span class="p">)</span> <span class="n">multicore_model</span><span class="p">(</span><span class="n">input0_tensor</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="example-python-api-usage-for-tf2-x-saved-models"> <h3>Example Python API Usage for TF2.x saved models:<a class="headerlink" href="#example-python-api-usage-for-tf2-x-saved-models" title="Permalink to this headline">#</a></h3> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">tensorflow.python</span> <span class="kn">import</span> <span class="n">saved_model</span> <span class="n">input0_tensor</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="n">num_cores</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">reload_model</span> <span class="o">=</span> <span class="n">saved_model</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">model_dir</span><span class="p">)</span> <span class="n">multicore_model</span> <span class="o">=</span> <span class="n">tfn</span><span class="o">.</span><span class="n">auto_multicore</span><span class="p">(</span><span class="n">reload_model</span><span class="p">,</span> <span class="n">input0_tensor</span><span class="p">,</span> <span class="n">num_cores</span><span class="o">=</span><span class="n">num_cores</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="tensorflow-neuron-tf2-x-tensorflow-neuronx-tf2-x-auto-multicore-replication-cli-experimental"> <span id="tensorflow-ref-auto-replication-cli-api"></span><h2><a class="toc-backref" href="#id4">TensorFlow Neuron TF2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span> <span class="pre">TF2.x</span></code>) Auto Multicore Replication CLI (Experimental)</a><a class="headerlink" href="#tensorflow-neuron-tf2-x-tensorflow-neuronx-tf2-x-auto-multicore-replication-cli-experimental" title="Permalink to this headline">#</a></h2> <p>The Neuron auto multicore replication CLI enables modifying Tensorflow 2.x traced saved models so that they can be automatically replicated across multiple cores. By performing this call on Tensorflow Saved Models, we can support Tensorflow-Serving without significant modifications to the code.</p> <div class="section" id="id1"> <h3>Method<a class="headerlink" href="#id1" title="Permalink to this headline">#</a></h3> <p><code class="docutils literal notranslate"><span class="pre">tf-neuron-auto-multicore</span> <span class="pre">MODEL_DIR</span> <span class="pre">--num_cores</span> <span class="pre">NUM_CORES</span> <span class="pre">--new_model_dir</span> <span class="pre">NEW_MODEL_DIR</span></code></p> </div> <div class="section" id="id2"> <h3>Arguments<a class="headerlink" href="#id2" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p><strong>MODEL_DIR:</strong> The directory of a saved AWS-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code>.</p></li> <li><p><strong>NUM_CORES:</strong> The desired number of cores where the model will be automatically replicated across</p></li> <li><p><strong>NEW_MODEL_DIR:</strong> The directory of where the AWS-Multicore-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will be saved</p></li> </ul> </div> <div class="section" id="example-cli-usage-for-tensorflow-serving-saved-models"> <h3>Example CLI Usage for Tensorflow-Serving saved models:<a class="headerlink" href="#example-cli-usage-for-tensorflow-serving-saved-models" title="Permalink to this headline">#</a></h3> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">tf</span><span class="o">-</span><span class="n">neuron</span><span class="o">-</span><span class="n">auto</span><span class="o">-</span><span class="n">multicore</span> <span class="o">./</span><span class="n">resnet</span> <span class="o">--</span><span class="n">num_cores</span> <span class="mi">8</span> <span class="o">--</span><span class="n">new_model_dir</span> <span class="o">./</span><span class="n">modified_resnet</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tfneuronx-python-tracing-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Tracing API</p> </div> </a> <a class="right-next" id="next-link" href="tfnx-analyze-model-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) analyze_model API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:15.590Z
Misc (tensorflow-neuronx) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html
# Misc (tensorflow-neuronx) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.rst) - [.rst](../../../_sources/frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.rst.txt) ## Misc (tensorflow-neuronx) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## Misc (`tensorflow-neuronx`)[#](#misc-tensorflow-neuronx "Permalink to this headline") - [TensorFlow Neuron (tensorflow-neuronx) Release Notes](../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html#tensorflow-neuronx-release-notes) _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Misc (tensorflow-neuronx) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow Neuron (tensorflow-neuronx) Release Notes" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> <link rel="prev" title="TensorFlow 2.x (tensorflow-neuronx) analyze_model API" href="tfnx-analyze-model-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Misc (tensorflow-neuronx)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="misc-tensorflow-neuronx"> <h1>Misc (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)<a class="headerlink" href="#misc-tensorflow-neuronx" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html#tensorflow-neuronx-release-notes"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuronx) Release Notes</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tfnx-analyze-model-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) analyze_model API</p> </div> </a> <a class="right-next" id="next-link" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Release Notes</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:16.121Z
TensorFlow 2.x (tensorflow-neuronx) analyze_model API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html
# TensorFlow 2.x (tensorflow-neuronx) analyze\_model API — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## TensorFlow 2.x (`tensorflow-neuronx`) analyze\_model API[#](#tensorflow-2-x-tensorflow-neuronx-analyze-model-api "Permalink to this headline") ## Method[#](#method "Permalink to this headline") `tensorflow_neuronx.analyze_model` ## Description[#](#description "Permalink to this headline") Analyzes a `keras.Model` or a Python callable that can be decorated by `tf.function` for it’s compatibility with Neuron. It displays supported vs. unsupported operators in the model as well as percentages and counts of each operator and returns a dictionary with operator statistics. ## Arguments[#](#arguments "Permalink to this headline") - **func:** The `keras.Model` or function to be analyzed. - **example\_inputs:** A `tf.Tensor` or a tuple/list/dict of `tf.Tensor` objects for tracing the function. When `example_inputs` is a `tf.Tensor` or a list of `tf.Tensor` objects, we expect `func` to have calling signature `func(example_inputs)`. Otherwise, the expectation is that inference on `func` is done by calling `func(*example_inputs)` when `example_inputs` is a `tuple`, or `func(**example_inputs)` when `example_inputs` is a `dict`. The case where `func` accepts mixed positional and keyword arguments is currently unsupported. ## Returns[#](#returns "Permalink to this headline") - A results `dict` with these keys: [\`\`](#id1)’percent\_supported’, ‘supported\_count’, > ‘total\_count’, ‘supported\_operators’, ‘unsupported\_operators’, ‘operators’, ‘operator\_count’[\`\`](#id3). ## Example Usage[#](#example-usage "Permalink to this headline") ``` import tensorflow as tf import tensorflow_neuron as tfnx input0 = tf.keras.layers.Input(3) dense0 = tf.keras.layers.Dense(3)(input0) model = tf.keras.Model(inputs=[input0], outputs=[dense0]) example_inputs = tf.random.uniform([1, 3]) results = tfnx.analyze_model(model, example_inputs) print(results) # expected output ''' BiasAdd MatMul 100.00% of all operations (2 of 2) are supported {'percent_supported': 100.0, 'supported_count': 2, 'total_count': 2, 'supported_operators': {'BiasAdd', 'MatMul'}, 'unsupported_operators': [], 'operators': ['BiasAdd', 'MatMul'], 'operator_count': {'MatMul': 1, 'BiasAdd': 1}} ''' ``` _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow 2.x (tensorflow-neuronx) analyze_model API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Misc (tensorflow-neuronx)" href="misc-tensorflow-neuronx.html"> <link rel="prev" title="TensorFlow Neuron (tensorflow-neuronx) Auto Multicore Replication (Experimental)" href="tf-neuronx-auto-replication-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow 2.x (tensorflow-neuronx) analyze_model API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="tensorflow-2-x-tensorflow-neuronx-analyze-model-api"> <span id="tf-neuronx-ref-analyze-model-api"></span><h1>TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) analyze_model API<a class="headerlink" href="#tensorflow-2-x-tensorflow-neuronx-analyze-model-api" title="Permalink to this headline">#</a></h1> <div class="section" id="method"> <h2>Method<a class="headerlink" href="#method" title="Permalink to this headline">#</a></h2> <p><code class="docutils literal notranslate"><span class="pre">tensorflow_neuronx.analyze_model</span></code></p> </div> <div class="section" id="description"> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2> <p>Analyzes a <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or a Python callable that can be decorated by <code class="docutils literal notranslate"><span class="pre">tf.function</span></code> for it’s compatibility with Neuron. It displays supported vs. unsupported operators in the model as well as percentages and counts of each operator and returns a dictionary with operator statistics.</p> </div> <div class="section" id="arguments"> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p><strong>func:</strong> The <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or function to be analyzed.</p></li> <li><p><strong>example_inputs:</strong> A <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a tuple/list/dict of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects for tracing the function. When <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects, we expect <code class="docutils literal notranslate"><span class="pre">func</span></code> to have calling signature <code class="docutils literal notranslate"><span class="pre">func(example_inputs)</span></code>. Otherwise, the expectation is that inference on <code class="docutils literal notranslate"><span class="pre">func</span></code> is done by calling <code class="docutils literal notranslate"><span class="pre">func(*example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tuple</span></code>, or <code class="docutils literal notranslate"><span class="pre">func(**example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">dict</span></code>. The case where <code class="docutils literal notranslate"><span class="pre">func</span></code> accepts mixed positional and keyword arguments is currently unsupported.</p></li> </ul> </div> <div class="section" id="returns"> <h2>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p>A results <code class="docutils literal notranslate"><span class="pre">dict</span></code> with these keys: <a href="#id1"><span class="problematic" id="id2">``</span></a>’percent_supported’, ‘supported_count’,</p></li> </ul> <blockquote> <div><p>‘total_count’, ‘supported_operators’, ‘unsupported_operators’, ‘operators’, ‘operator_count’<a href="#id3"><span class="problematic" id="id4">``</span></a>.</p> </div></blockquote> </div> <div class="section" id="example-usage"> <h2>Example Usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">#</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">import</span> <span class="nn">tensorflow_neuron</span> <span class="k">as</span> <span class="nn">tfnx</span> <span class="n">input0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Input</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="n">dense0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">3</span><span class="p">)(</span><span class="n">input0</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">Model</span><span class="p">(</span><span class="n">inputs</span><span class="o">=</span><span class="p">[</span><span class="n">input0</span><span class="p">],</span> <span class="n">outputs</span><span class="o">=</span><span class="p">[</span><span class="n">dense0</span><span class="p">])</span> <span class="n">example_inputs</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="n">results</span> <span class="o">=</span> <span class="n">tfnx</span><span class="o">.</span><span class="n">analyze_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">results</span><span class="p">)</span> <span class="c1"># expected output</span> <span class="sd">'''</span> <span class="sd">BiasAdd</span> <span class="sd"> MatMul</span> <span class="sd"> 100.00% of all operations (2 of 2) are supported</span> <span class="sd"> {'percent_supported': 100.0, 'supported_count': 2, 'total_count': 2,</span> <span class="sd"> 'supported_operators': {'BiasAdd', 'MatMul'}, 'unsupported_operators': [],</span> <span class="sd"> 'operators': ['BiasAdd', 'MatMul'], 'operator_count': {'MatMul': 1, 'BiasAdd': 1}}</span> <span class="sd"> '''</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tf-neuronx-auto-replication-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Auto Multicore Replication (Experimental)</p> </div> </a> <a class="right-next" id="next-link" href="misc-tensorflow-neuronx.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Misc (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:16.284Z
TensorFlow Neuron (tensorflow-neuronx) Release Notes — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html
# TensorFlow Neuron (tensorflow-neuronx) Release Notes — AWS Neuron Documentation _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n` ## TensorFlow Neuron (`tensorflow-neuronx`) Release Notes[#](#tensorflow-neuron-tensorflow-neuronx-release-notes "Permalink to this headline") Table of contents - [tensorflow-neuronx 2.x release \[2.1.0\]](#tensorflow-neuronx-2-x-release-2-1-0) - [tensorflow-neuronx 2.10 release \[2.0.0\]](#tensorflow-neuronx-2-10-release-2-0-0) - [tensorflow-neuronx 2.10 release \[1.0.0\]](#tensorflow-neuronx-2-10-release-1-0-0) This document lists the release notes for the tensorflow-neuronx 2.x packages. ## [tensorflow-neuronx 2.x release \[2.1.0\]](#id1)[#](#tensorflow-neuronx-2-x-release-2-1-0 "Permalink to this headline") Date: 09/15/2023 - Minor updates Date: 05/1/2023 - Added support for tracing models larger than 2 GB through the environment variable `NEURON_CC_FLAGS='--extract-weights INSTANCE_TYPE'` for all trn1 and inf2 instance types. - tensorflow-neuronx now supports tensorflow 2.7, 2.8, and 2.9 (In addition to the already supported 2.10). - Neuron release 2.10 release will be the last release that will include support for tensorflow-neuronx version 2.7. Future Neuron releases will not include tensorflow-neuronx version 2.7. ## [tensorflow-neuronx 2.10 release \[2.0.0\]](#id2)[#](#tensorflow-neuronx-2-10-release-2-0-0 "Permalink to this headline") Date: 03/28/2023 The second release of tensorflow-neuronx 2.10 includes the following features: - Dynamic batching The following features are not included in this release: - Support for tracing models larger than 2 GB ## [tensorflow-neuronx 2.10 release \[1.0.0\]](#id3)[#](#tensorflow-neuronx-2-10-release-1-0-0 "Permalink to this headline") Date: 2/24/2023 The initial release of tensorflow-neuronx 2.10 includes the following features: - Initial support for TensorFlow 2.10 inference on Inf2 and Trn1 - Trace API (tensorflow\_neuronx.trace) - Automatic partitioning of model into CPU vs NeuronCore parts - Automatic data parallel on multiple NeuronCores (experimental) - Python 3.7, 3.8 and 3.9 support - HuggingFace Roberta tutorial The following features are not included in this release: - Dynamic batching - Support for tracing models larger than 2 GB _This document is relevant for_: `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow Neuron (tensorflow-neuronx) Release Notes — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Inference on Inf1 (tensorflow-neuron)" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> <link rel="prev" title="Misc (tensorflow-neuronx)" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Frelease-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuronx-2-x-release-2-1-0"> tensorflow-neuronx 2.x release [2.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuronx-2-10-release-2-0-0"> tensorflow-neuronx 2.10 release [2.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuronx-2-10-release-1-0-0"> tensorflow-neuronx 2.10 release [1.0.0] </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow Neuron (tensorflow-neuronx) Release Notes</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuronx-2-x-release-2-1-0"> tensorflow-neuronx 2.x release [2.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuronx-2-10-release-2-0-0"> tensorflow-neuronx 2.10 release [2.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuronx-2-10-release-1-0-0"> tensorflow-neuronx 2.10 release [1.0.0] </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="tensorflow-neuron-tensorflow-neuronx-release-notes"> <span id="tensorflow-neuronx-release-notes"></span><h1>TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Release Notes<a class="headerlink" href="#tensorflow-neuron-tensorflow-neuronx-release-notes" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#tensorflow-neuronx-2-x-release-2-1-0" id="id1">tensorflow-neuronx 2.x release [2.1.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuronx-2-10-release-2-0-0" id="id2">tensorflow-neuronx 2.10 release [2.0.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuronx-2-10-release-1-0-0" id="id3">tensorflow-neuronx 2.10 release [1.0.0]</a></p></li> </ul> </div> <p>This document lists the release notes for the tensorflow-neuronx 2.x packages.</p> <div class="section" id="tensorflow-neuronx-2-x-release-2-1-0"> <h2><a class="toc-backref" href="#id1">tensorflow-neuronx 2.x release [2.1.0]</a><a class="headerlink" href="#tensorflow-neuronx-2-x-release-2-1-0" title="Permalink to this headline">#</a></h2> <p>Date: 09/15/2023</p> <ul class="simple"> <li><p>Minor updates</p></li> </ul> <p>Date: 05/1/2023</p> <ul class="simple"> <li><p>Added support for tracing models larger than 2 GB through the environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--extract-weights</span> <span class="pre">INSTANCE_TYPE'</span></code> for all trn1 and inf2 instance types.</p></li> <li><p>tensorflow-neuronx now supports tensorflow 2.7, 2.8, and 2.9 (In addition to the already supported 2.10).</p></li> <li><p>Neuron release 2.10 release will be the last release that will include support for tensorflow-neuronx version 2.7. Future Neuron releases will not include tensorflow-neuronx version 2.7.</p></li> </ul> </div> <div class="section" id="tensorflow-neuronx-2-10-release-2-0-0"> <h2><a class="toc-backref" href="#id2">tensorflow-neuronx 2.10 release [2.0.0]</a><a class="headerlink" href="#tensorflow-neuronx-2-10-release-2-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 03/28/2023</p> <p>The second release of tensorflow-neuronx 2.10 includes the following features:</p> <ul class="simple"> <li><p>Dynamic batching</p></li> </ul> <p>The following features are not included in this release:</p> <ul class="simple"> <li><p>Support for tracing models larger than 2 GB</p></li> </ul> </div> <div class="section" id="tensorflow-neuronx-2-10-release-1-0-0"> <h2><a class="toc-backref" href="#id3">tensorflow-neuronx 2.10 release [1.0.0]</a><a class="headerlink" href="#tensorflow-neuronx-2-10-release-1-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 2/24/2023</p> <p>The initial release of tensorflow-neuronx 2.10 includes the following features:</p> <ul class="simple"> <li><p>Initial support for TensorFlow 2.10 inference on Inf2 and Trn1</p></li> <li><p>Trace API (tensorflow_neuronx.trace)</p></li> <li><p>Automatic partitioning of model into CPU vs NeuronCore parts</p></li> <li><p>Automatic data parallel on multiple NeuronCores (experimental)</p></li> <li><p>Python 3.7, 3.8 and 3.9 support</p></li> <li><p>HuggingFace Roberta tutorial</p></li> </ul> <p>The following features are not included in this release:</p> <ul class="simple"> <li><p>Dynamic batching</p></li> <li><p>Support for tracing models larger than 2 GB</p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Misc (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Inference on Inf1 (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:16.824Z
Tutorials (tensorflow-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html
# Tutorials (tensorflow-neuron) — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## Tutorials (`tensorflow-neuron`)[#](#tutorials-tensorflow-neuron "Permalink to this headline") Computer Vision Tutorials - Tensorflow 1.x - OpenPose tutorial [\[html\]](../../../../src/examples/tensorflow/openpose_demo/openpose.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/openpose_demo/openpose.ipynb) - Tensorflow 1.x - ResNet-50 tutorial [\[html\]](../../../../src/examples/tensorflow/tensorflow_resnet50/resnet50.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow_resnet50/resnet50.ipynb) - Tensorflow 1.x - YOLOv4 tutorial [\[html\]](yolo_v4_demo/yolo_v4_demo.html#tensorflow-yolo4) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v4_demo/evaluate.ipynb) - Tensorflow 1.x - YOLOv3 tutorial [\[html\]](../../../../src/examples/tensorflow/yolo_v3_demo/yolo_v3.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v3_demo/yolo_v3.ipynb) - Tensorflow 1.x - SSD300 tutorial [\[html\]](ssd300_demo/ssd300_demo.html#tensorflow-ssd300) - Tensorflow 1.x - Keras ResNet-50 optimization tutorial [\[html\]](../../../../src/examples/tensorflow/keras_resnet50/keras_resnet50.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/keras_resnet50/keras_resnet50.ipynb) Natural Language Processing (NLP) Tutorials - Tensorflow 1.x - Running TensorFlow BERT-Large with AWS Neuron [\[html\]](bert_demo/bert_demo.html#tensorflow-bert-demo) - Tensorflow 2.x - HuggingFace Pipelines distilBERT with Tensorflow2 Neuron [\[html\]](../../../../src/examples/tensorflow/huggingface_bert/huggingface_bert.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/huggingface_bert/huggingface_bert.ipynb) Utilizing Neuron Capabilities Tutorials - Tensorflow 1.x & 2.x - Using NEURON\_RT\_VISIBLE\_CORES with TensorFlow Serving [\[html\]](../../../../src/examples/tensorflow/tensorflow_serving_tutorial.html) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Tutorials (tensorflow-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Computer Vision Tutorials (tensorflow-neuron)" href="tutorials-tensorflow-computervision.html"> <link rel="prev" title="Inference on Inf1 (tensorflow-neuron)" href="../../tensorflow-neuron-inference.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Tutorials (tensorflow-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tutorials-tensorflow-neuron"> <h1>Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<a class="headerlink" href="#tutorials-tensorflow-neuron" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <div class="sd-tab-set docutils"> <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-0" id="id1"> Computer Vision Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p>Tensorflow 1.x - OpenPose tutorial <a class="reference internal" href="../../../../src/examples/tensorflow/openpose_demo/openpose.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/openpose_demo/openpose.ipynb">[notebook]</a></p></li> <li><p>Tensorflow 1.x - ResNet-50 tutorial <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow_resnet50/resnet50.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow_resnet50/resnet50.ipynb">[notebook]</a></p></li> <li><p>Tensorflow 1.x - YOLOv4 tutorial <a class="reference internal" href="yolo_v4_demo/yolo_v4_demo.html#tensorflow-yolo4"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v4_demo/evaluate.ipynb">[notebook]</a></p></li> <li><p>Tensorflow 1.x - YOLOv3 tutorial <a class="reference internal" href="../../../../src/examples/tensorflow/yolo_v3_demo/yolo_v3.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v3_demo/yolo_v3.ipynb">[notebook]</a></p></li> <li><p>Tensorflow 1.x - SSD300 tutorial <a class="reference internal" href="ssd300_demo/ssd300_demo.html#tensorflow-ssd300"><span class="std std-ref">[html]</span></a></p></li> <li><p>Tensorflow 1.x - Keras ResNet-50 optimization tutorial <a class="reference internal" href="../../../../src/examples/tensorflow/keras_resnet50/keras_resnet50.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/keras_resnet50/keras_resnet50.ipynb">[notebook]</a></p></li> </ul> </div> <input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-1" id="id2"> Natural Language Processing (NLP) Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p>Tensorflow 1.x - Running TensorFlow BERT-Large with AWS Neuron <a class="reference internal" href="bert_demo/bert_demo.html#tensorflow-bert-demo"><span class="std std-ref">[html]</span></a></p></li> <li><p>Tensorflow 2.x - HuggingFace Pipelines distilBERT with Tensorflow2 Neuron <a class="reference internal" href="../../../../src/examples/tensorflow/huggingface_bert/huggingface_bert.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/huggingface_bert/huggingface_bert.ipynb">[notebook]</a></p></li> </ul> </div> <input id="sd-tab-item-2" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-2" id="id3"> Utilizing Neuron Capabilities Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p>Tensorflow 1.x &amp; 2.x - Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow_serving_tutorial.html"><span class="std std-ref">[html]</span></a></p></li> </ul> </div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>To use Jupyter Notebook see:</p> <ul class="simple"> <li><p><a class="reference internal" href="../../../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p><a class="reference internal" href="../../../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../tensorflow-neuron-inference.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Inference on Inf1 (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="tutorials-tensorflow-computervision.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Computer Vision Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:16.962Z
Computer Vision Tutorials (tensorflow-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html
# Computer Vision Tutorials (tensorflow-neuron) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.rst) - [.rst](../../../../_sources/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.rst.txt) ## Computer Vision Tutorials (tensorflow-neuron) _This document is relevant for_: `Inf1` ## Computer Vision Tutorials (`tensorflow-neuron`)[#](#computer-vision-tutorials-tensorflow-neuron "Permalink to this headline") - Tensorflow 1.x - OpenPose tutorial [\[html\]](../../../../src/examples/tensorflow/openpose_demo/openpose.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/openpose_demo/openpose.ipynb) - Tensorflow 1.x - ResNet-50 tutorial [\[html\]](../../../../src/examples/tensorflow/tensorflow_resnet50/resnet50.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow_resnet50/resnet50.ipynb) - Tensorflow 1.x - YOLOv4 tutorial [\[html\]](yolo_v4_demo/yolo_v4_demo.html#tensorflow-yolo4) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v4_demo/evaluate.ipynb) - Tensorflow 1.x - YOLOv3 tutorial [\[html\]](../../../../src/examples/tensorflow/yolo_v3_demo/yolo_v3.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v3_demo/yolo_v3.ipynb) - Tensorflow 1.x - SSD300 tutorial [\[html\]](ssd300_demo/ssd300_demo.html#tensorflow-ssd300) - Tensorflow 1.x - Keras ResNet-50 optimization tutorial [\[html\]](../../../../src/examples/tensorflow/keras_resnet50/keras_resnet50.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/keras_resnet50/keras_resnet50.ipynb) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Computer Vision Tutorials (tensorflow-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Running OpenPose on Inferentia" href="../../../../src/examples/tensorflow/openpose_demo/openpose.html"> <link rel="prev" title="Tutorials (tensorflow-neuron)" href="tutorials-tensorflow-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-tensorflow-neuron.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Computer Vision Tutorials (tensorflow-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="computer-vision-tutorials-tensorflow-neuron"> <h1>Computer Vision Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<a class="headerlink" href="#computer-vision-tutorials-tensorflow-neuron" title="Permalink to this headline">#</a></h1> <ul class="simple"> <li><p>Tensorflow 1.x - OpenPose tutorial <a class="reference internal" href="../../../../src/examples/tensorflow/openpose_demo/openpose.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/openpose_demo/openpose.ipynb">[notebook]</a></p></li> <li><p>Tensorflow 1.x - ResNet-50 tutorial <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow_resnet50/resnet50.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow_resnet50/resnet50.ipynb">[notebook]</a></p></li> <li><p>Tensorflow 1.x - YOLOv4 tutorial <a class="reference internal" href="yolo_v4_demo/yolo_v4_demo.html#tensorflow-yolo4"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v4_demo/evaluate.ipynb">[notebook]</a></p></li> <li><p>Tensorflow 1.x - YOLOv3 tutorial <a class="reference internal" href="../../../../src/examples/tensorflow/yolo_v3_demo/yolo_v3.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v3_demo/yolo_v3.ipynb">[notebook]</a></p></li> <li><p>Tensorflow 1.x - SSD300 tutorial <a class="reference internal" href="ssd300_demo/ssd300_demo.html#tensorflow-ssd300"><span class="std std-ref">[html]</span></a></p></li> <li><p>Tensorflow 1.x - Keras ResNet-50 optimization tutorial <a class="reference internal" href="../../../../src/examples/tensorflow/keras_resnet50/keras_resnet50.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/keras_resnet50/keras_resnet50.ipynb">[notebook]</a></p></li> </ul> <div class="toctree-wrapper compound"> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tutorials-tensorflow-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="../../../../src/examples/tensorflow/openpose_demo/openpose.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Running OpenPose on Inferentia</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:17.183Z
Inference on Inf1 (tensorflow-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron-inference.html
# Inference on Inf1 (tensorflow-neuron) — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## Inference on Inf1 (`tensorflow-neuron`)[#](#inference-on-inf1-tensorflow-neuron "Permalink to this headline") Setup (`tensorflow-neuron`) Computer Vision Tutorials - Tensorflow 1.x - OpenPose tutorial [\[html\]](../../src/examples/tensorflow/openpose_demo/openpose.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/openpose_demo/openpose.ipynb) - Tensorflow 1.x - ResNet-50 tutorial [\[html\]](../../src/examples/tensorflow/tensorflow_resnet50/resnet50.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow_resnet50/resnet50.ipynb) - Tensorflow 1.x - YOLOv4 tutorial [\[html\]](tensorflow-neuron/tutorials/yolo_v4_demo/yolo_v4_demo.html#tensorflow-yolo4) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v4_demo/evaluate.ipynb) - Tensorflow 1.x - YOLOv3 tutorial [\[html\]](../../src/examples/tensorflow/yolo_v3_demo/yolo_v3.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v3_demo/yolo_v3.ipynb) - Tensorflow 1.x - SSD300 tutorial [\[html\]](tensorflow-neuron/tutorials/ssd300_demo/ssd300_demo.html#tensorflow-ssd300) - Tensorflow 1.x - Keras ResNet-50 optimization tutorial [\[html\]](../../src/examples/tensorflow/keras_resnet50/keras_resnet50.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/keras_resnet50/keras_resnet50.ipynb) Natural Language Processing (NLP) Tutorials - Tensorflow 1.x - Running TensorFlow BERT-Large with AWS Neuron [\[html\]](tensorflow-neuron/tutorials/bert_demo/bert_demo.html#tensorflow-bert-demo) - Tensorflow 2.x - HuggingFace Pipelines distilBERT with Tensorflow2 Neuron [\[html\]](../../src/examples/tensorflow/huggingface_bert/huggingface_bert.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/huggingface_bert/huggingface_bert.ipynb) Utilizing Neuron Capabilities Tutorials - Tensorflow 1.x & 2.x - Using NEURON\_RT\_VISIBLE\_CORES with TensorFlow Serving [\[html\]](../../src/examples/tensorflow/tensorflow_serving_tutorial.html) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Inference on Inf1 (tensorflow-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="Tutorials (tensorflow-neuron)" href="tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> <link rel="prev" title="TensorFlow Neuron (tensorflow-neuronx) Release Notes" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron-inference", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="current reference internal" href="#"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron-inference.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron-inference.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/tensorflow/tensorflow-neuron-inference.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Inference on Inf1 (tensorflow-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="inference-on-inf1-tensorflow-neuron"> <span id="inference-tensorflow-neuron"></span><h1>Inference on Inf1 (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<a class="headerlink" href="#inference-on-inf1-tensorflow-neuron" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body sphinx-design-class-title-small docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Setup (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</div> </div> <a class="sd-stretched-link reference internal" href="../../general/setup/tensorflow-neuron.html#setup-tensorflow-neuron"><span class="std std-ref"></span></a></div> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-med"> Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body docutils"> <div class="sd-tab-set docutils"> <input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-0" id="id1"> Computer Vision Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p class="sd-card-text">Tensorflow 1.x - OpenPose tutorial <a class="reference internal" href="../../src/examples/tensorflow/openpose_demo/openpose.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/openpose_demo/openpose.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text">Tensorflow 1.x - ResNet-50 tutorial <a class="reference internal" href="../../src/examples/tensorflow/tensorflow_resnet50/resnet50.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/tensorflow_resnet50/resnet50.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text">Tensorflow 1.x - YOLOv4 tutorial <a class="reference internal" href="tensorflow-neuron/tutorials/yolo_v4_demo/yolo_v4_demo.html#tensorflow-yolo4"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v4_demo/evaluate.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text">Tensorflow 1.x - YOLOv3 tutorial <a class="reference internal" href="../../src/examples/tensorflow/yolo_v3_demo/yolo_v3.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/yolo_v3_demo/yolo_v3.ipynb">[notebook]</a></p></li> <li><p class="sd-card-text">Tensorflow 1.x - SSD300 tutorial <a class="reference internal" href="tensorflow-neuron/tutorials/ssd300_demo/ssd300_demo.html#tensorflow-ssd300"><span class="std std-ref">[html]</span></a></p></li> <li><p class="sd-card-text">Tensorflow 1.x - Keras ResNet-50 optimization tutorial <a class="reference internal" href="../../src/examples/tensorflow/keras_resnet50/keras_resnet50.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/keras_resnet50/keras_resnet50.ipynb">[notebook]</a></p></li> </ul> </div> <input id="sd-tab-item-1" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-1" id="id2"> Natural Language Processing (NLP) Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p class="sd-card-text">Tensorflow 1.x - Running TensorFlow BERT-Large with AWS Neuron <a class="reference internal" href="tensorflow-neuron/tutorials/bert_demo/bert_demo.html#tensorflow-bert-demo"><span class="std std-ref">[html]</span></a></p></li> <li><p class="sd-card-text">Tensorflow 2.x - HuggingFace Pipelines distilBERT with Tensorflow2 Neuron <a class="reference internal" href="../../src/examples/tensorflow/huggingface_bert/huggingface_bert.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/huggingface_bert/huggingface_bert.ipynb">[notebook]</a></p></li> </ul> </div> <input id="sd-tab-item-2" name="sd-tab-set-0" type="radio"> <label class="sd-tab-label" for="sd-tab-item-2" id="id3"> Utilizing Neuron Capabilities Tutorials</label><div class="sd-tab-content docutils"> <ul class="simple"> <li><p class="sd-card-text">Tensorflow 1.x &amp; 2.x - Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving <a class="reference internal" href="../../src/examples/tensorflow/tensorflow_serving_tutorial.html"><span class="std std-ref">[html]</span></a></p></li> </ul> </div> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p class="sd-card-text">To use Jupyter Notebook see:</p> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/setup-jupyter-notebook-steps-troubleshooting.html#setup-jupyter-notebook-steps-troubleshooting"><span class="std std-ref">Jupyter Notebook QuickStart</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../general/setup/notebook/running-jupyter-notebook-as-script.html#running-jupyter-notebook-as-script"><span class="std std-ref">Running Jupyter Notebook as script</span></a></p></li> </ul> </div> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-med"> Additional Examples (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference">AWS Neuron Samples GitHub Repository</a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-med"> API Reference Guide (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="tensorflow-neuron/api-tracing-python-api.html#tensorflow-ref-neuron-tracing-api"><span class="std std-ref">TensorFlow 2.x (tensorflow-neuron) Tracing API</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="tensorflow-neuron/api-tfn-analyze-model-api.html#tensorflow-ref-neuron-analyze-model-api"><span class="std std-ref">TensorFlow 2.x (tensorflow-neuron) analyze_model API</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="tensorflow-neuron/api-compilation-python-api.html#tensorflow-ref-neuron-compile-api"><span class="std std-ref">TensorFlow 1.x (tensorflow-neuron) Compilation API</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="tensorflow-neuron/api-auto-replication-api.html#tensorflow-ref-auto-replication-python-api"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron) Auto Multicore Replication (Experimental)</span></a></p></li> </ul> </div> </details><details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3 sd-fade-in"> <summary class="sd-summary-title sd-card-header sphinx-design-class-title-med"> Misc (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<div class="sd-summary-down docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div> <div class="sd-summary-up docutils"> <svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div> </summary><div class="sd-summary-content sd-card-body sphinx-design-class-body-small docutils"> <ul class="simple"> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html#tensorflow-neuron-release-notes"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF1.x)) Release Notes</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html#tensorflow-neuron-rn-v2"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF2.x)) Release Notes</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="tensorflow-neuron/tensorflow2-accelerated-ops.html#tensorflow-ref-neuron-accelerated-ops"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF2.x)) Accelerated (torch-neuron) Python APIs and Graph Ops</span></a></p></li> <li><p class="sd-card-text"><a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html#neuron-cc-ops-tensorflow"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators</span></a></p></li> </ul> </div> </details><p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuronx</span></code>) Release Notes</p> </div> </a> <a class="right-next" id="next-link" href="tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:17.353Z
Utilizing Neuron Capabilities Tutorials (tensorflow-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html
# Utilizing Neuron Capabilities Tutorials (tensorflow-neuron) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.rst) - [.rst](../../../../_sources/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.rst.txt) ## Utilizing Neuron Capabilities Tutorials (tensorflow-neuron) _This document is relevant for_: `Inf1` ## Utilizing Neuron Capabilities Tutorials (`tensorflow-neuron`)[#](#utilizing-neuron-capabilities-tutorials-tensorflow-neuron "Permalink to this headline") - Tensorflow 1.x - Using NEURON\_RT\_VISIBLE\_CORES with TensorFlow Serving [\[html\]](../../../../src/examples/tensorflow/tensorflow_serving_tutorial.html#tensorflow-serving-neuronrt-visible-cores) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Utilizing Neuron Capabilities Tutorials (tensorflow-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Additional Examples (tensorflow-neuron)" href="../additional-examples.html"> <link rel="prev" title="Running Huggingface DistilBERT with TensorFlow-Neuron" href="../../../../src/examples/tensorflow/huggingface_bert/huggingface_bert.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-tensorflow-neuron.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Utilizing Neuron Capabilities Tutorials (tensorflow-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="utilizing-neuron-capabilities-tutorials-tensorflow-neuron"> <h1>Utilizing Neuron Capabilities Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<a class="headerlink" href="#utilizing-neuron-capabilities-tutorials-tensorflow-neuron" title="Permalink to this headline">#</a></h1> <ul class="simple"> <li><p>Tensorflow 1.x - Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow_serving_tutorial.html#tensorflow-serving-neuronrt-visible-cores"><span class="std std-ref">[html]</span></a></p></li> </ul> <div class="toctree-wrapper compound"> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../src/examples/tensorflow/huggingface_bert/huggingface_bert.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Running Huggingface DistilBERT with TensorFlow-Neuron</p> </div> </a> <a class="right-next" id="next-link" href="../additional-examples.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Additional Examples (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:18.012Z
Natural Language Processing (NLP) Tutorials (tensorflow-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html
# Natural Language Processing (NLP) Tutorials (tensorflow-neuron) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.rst) - [.rst](../../../../_sources/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.rst.txt) ## Natural Language Processing (NLP) Tutorials (tensorflow-neuron) _This document is relevant for_: `Inf1` ## Natural Language Processing (NLP) Tutorials (`tensorflow-neuron`)[#](#natural-language-processing-nlp-tutorials-tensorflow-neuron "Permalink to this headline") - Tensorflow 1.x - Running TensorFlow BERT-Large with AWS Neuron [\[html\]](bert_demo/bert_demo.html#tensorflow-bert-demo) - Tensorflow 2.x - HuggingFace DistilBERT with Tensorflow2 Neuron [\[html\]](../../../../src/examples/tensorflow/huggingface_bert/huggingface_bert.html) [\[notebook\]](https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/huggingface_bert/huggingface_bert.ipynb) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Natural Language Processing (NLP) Tutorials (tensorflow-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Running TensorFlow BERT-Large with AWS Neuron" href="bert_demo/bert_demo.html"> <link rel="prev" title="Tensorflow ResNet 50 Optimization Tutorial" href="../../../../src/examples/tensorflow/keras_resnet50/keras_resnet50.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="tutorials-tensorflow-neuron.html"> Tutorials </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Natural Language Processing (NLP) Tutorials (tensorflow-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="natural-language-processing-nlp-tutorials-tensorflow-neuron"> <h1>Natural Language Processing (NLP) Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<a class="headerlink" href="#natural-language-processing-nlp-tutorials-tensorflow-neuron" title="Permalink to this headline">#</a></h1> <ul class="simple"> <li><p>Tensorflow 1.x - Running TensorFlow BERT-Large with AWS Neuron <a class="reference internal" href="bert_demo/bert_demo.html#tensorflow-bert-demo"><span class="std std-ref">[html]</span></a></p></li> <li><p>Tensorflow 2.x - HuggingFace DistilBERT with Tensorflow2 Neuron <a class="reference internal" href="../../../../src/examples/tensorflow/huggingface_bert/huggingface_bert.html"><span class="std std-ref">[html]</span></a> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sdk/blob/v2.14.1/src/examples/tensorflow/huggingface_bert/huggingface_bert.ipynb">[notebook]</a></p></li> </ul> <div class="toctree-wrapper compound"> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../src/examples/tensorflow/keras_resnet50/keras_resnet50.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Tensorflow ResNet 50 Optimization Tutorial</p> </div> </a> <a class="right-next" id="next-link" href="bert_demo/bert_demo.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Running TensorFlow BERT-Large with AWS Neuron</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:18.171Z
Additional Examples (tensorflow-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/additional-examples.html
# Additional Examples (tensorflow-neuron) — AWS Neuron Documentation - [repository](https://github.com/aws-neuron/aws-neuron-sdk) - [open issue](https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/additional-examples.html&body=Your%20issue%20content%20here.) - [suggest edit](https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/additional-examples.rst) - [.rst](../../../_sources/frameworks/tensorflow/tensorflow-neuron/additional-examples.rst.txt) ## Additional Examples (tensorflow-neuron) _This document is relevant for_: `Inf1` ## Additional Examples (`tensorflow-neuron`)[#](#additional-examples-tensorflow-neuron "Permalink to this headline") - [AWS Neuron Samples GitHub Repository](https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference) _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Additional Examples (tensorflow-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="API Reference Guide (tensorflow-neuron)" href="api-reference-guide.html"> <link rel="prev" title="Utilizing Neuron Capabilities Tutorials (tensorflow-neuron)" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/additional-examples", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Additional Examples </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/additional-examples.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/additional-examples.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuron/additional-examples.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Additional Examples (tensorflow-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="additional-examples-tensorflow-neuron"> <h1>Additional Examples (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<a class="headerlink" href="#additional-examples-tensorflow-neuron" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference">AWS Neuron Samples GitHub Repository</a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Utilizing Neuron Capabilities Tutorials (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="api-reference-guide.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">API Reference Guide (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:18.696Z
API Reference Guide (tensorflow-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html
# API Reference Guide (tensorflow-neuron) — AWS Neuron Documentation previous Additional Examples (`tensorflow-neuron`)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>API Reference Guide (tensorflow-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow 2.x (tensorflow-neuron) Tracing API" href="api-tracing-python-api.html"> <link rel="prev" title="Additional Examples (tensorflow-neuron)" href="additional-examples.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/api-reference-guide", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/api-reference-guide.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-reference-guide.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuron/api-reference-guide.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>API Reference Guide (tensorflow-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="api-reference-guide-tensorflow-neuron"> <h1>API Reference Guide (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<a class="headerlink" href="#api-reference-guide-tensorflow-neuron" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="api-tracing-python-api.html#tensorflow-ref-neuron-tracing-api"><span class="std std-ref">TensorFlow 2.x (tensorflow-neuron) Tracing API</span></a></p></li> <li><p><a class="reference internal" href="api-tfn-analyze-model-api.html#tensorflow-ref-neuron-analyze-model-api"><span class="std std-ref">TensorFlow 2.x (tensorflow-neuron) analyze_model API</span></a></p></li> <li><p><a class="reference internal" href="api-compilation-python-api.html#tensorflow-ref-neuron-compile-api"><span class="std std-ref">TensorFlow 1.x (tensorflow-neuron) Compilation API</span></a></p></li> <li><p><a class="reference internal" href="api-auto-replication-api.html#tensorflow-ref-auto-replication-python-api"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron) Auto Multicore Replication (Experimental)</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="additional-examples.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Additional Examples (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="api-tracing-python-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Tracing API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:19.034Z
TensorFlow 2.x (tensorflow-neuron) analyze_model API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html
# TensorFlow 2.x (tensorflow-neuron) analyze\_model API — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf1` ## TensorFlow 2.x (`tensorflow-neuron`) analyze\_model API[#](#tensorflow-2-x-tensorflow-neuron-analyze-model-api "Permalink to this headline") ## Method[#](#method "Permalink to this headline") `tensorflow.neuron.analyze_model` ## Description[#](#description "Permalink to this headline") Analyzes a `keras.Model` or a Python callable that can be decorated by `tf.function` for it’s compatibility with Neuron. It displays supported vs. unsupported operators in the model as well as percentages and counts of each operator and returns a dictionary with operator statistics. ## Arguments[#](#arguments "Permalink to this headline") - **func:** The `keras.Model` or function to be analyzed. - **example\_inputs:** A `tf.Tensor` or a tuple/list/dict of `tf.Tensor` objects for tracing the function. When `example_inputs` is a `tf.Tensor` or a list of `tf.Tensor` objects, we expect `func` to have calling signature `func(example_inputs)`. Otherwise, the expectation is that inference on `func` is done by calling `func(*example_inputs)` when `example_inputs` is a `tuple`, or `func(**example_inputs)` when `example_inputs` is a `dict`. The case where `func` accepts mixed positional and keyword arguments is currently unsupported. ## Returns[#](#returns "Permalink to this headline") - A results `dict` with these keys: [\`\`](#id1)’percent\_supported’, ‘supported\_count’, > ‘total\_count’, ‘supported\_operators’, ‘unsupported\_operators’, ‘operators’, ‘operator\_count’[\`\`](#id3). ## Example Usage[#](#example-usage "Permalink to this headline") ``` import tensorflow as tf import tensorflow.neuron as tfn input0 = tf.keras.layers.Input(3) dense0 = tf.keras.layers.Dense(3)(input0) model = tf.keras.Model(inputs=[input0], outputs=[dense0]) example_inputs = tf.random.uniform([1, 3]) results = tfn.analyze_model(model, example_inputs) print(results) # expected output ''' BiasAdd MatMul 100.00% of all operations (2 of 2) are supported {'percent_supported': 100.0, 'supported_count': 2, 'total_count': 2, 'supported_operators': {'BiasAdd', 'MatMul'}, 'unsupported_operators': [], 'operators': ['BiasAdd', 'MatMul'], 'operator_count': {'MatMul': 1, 'BiasAdd': 1}} ''' ``` _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow 2.x (tensorflow-neuron) analyze_model API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow 1.x (tensorflow-neuron) Compilation API" href="api-compilation-python-api.html"> <link rel="prev" title="TensorFlow 2.x (tensorflow-neuron) Tracing API" href="api-tracing-python-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow 2.x (tensorflow-neuron) analyze_model API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tensorflow-2-x-tensorflow-neuron-analyze-model-api"> <span id="tensorflow-ref-neuron-analyze-model-api"></span><h1>TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) analyze_model API<a class="headerlink" href="#tensorflow-2-x-tensorflow-neuron-analyze-model-api" title="Permalink to this headline">#</a></h1> <div class="section" id="method"> <h2>Method<a class="headerlink" href="#method" title="Permalink to this headline">#</a></h2> <p><code class="docutils literal notranslate"><span class="pre">tensorflow.neuron.analyze_model</span></code></p> </div> <div class="section" id="description"> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2> <p>Analyzes a <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or a Python callable that can be decorated by <code class="docutils literal notranslate"><span class="pre">tf.function</span></code> for it’s compatibility with Neuron. It displays supported vs. unsupported operators in the model as well as percentages and counts of each operator and returns a dictionary with operator statistics.</p> </div> <div class="section" id="arguments"> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p><strong>func:</strong> The <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or function to be analyzed.</p></li> <li><p><strong>example_inputs:</strong> A <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a tuple/list/dict of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects for tracing the function. When <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects, we expect <code class="docutils literal notranslate"><span class="pre">func</span></code> to have calling signature <code class="docutils literal notranslate"><span class="pre">func(example_inputs)</span></code>. Otherwise, the expectation is that inference on <code class="docutils literal notranslate"><span class="pre">func</span></code> is done by calling <code class="docutils literal notranslate"><span class="pre">func(*example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tuple</span></code>, or <code class="docutils literal notranslate"><span class="pre">func(**example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">dict</span></code>. The case where <code class="docutils literal notranslate"><span class="pre">func</span></code> accepts mixed positional and keyword arguments is currently unsupported.</p></li> </ul> </div> <div class="section" id="returns"> <h2>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p>A results <code class="docutils literal notranslate"><span class="pre">dict</span></code> with these keys: <a href="#id1"><span class="problematic" id="id2">``</span></a>’percent_supported’, ‘supported_count’,</p></li> </ul> <blockquote> <div><p>‘total_count’, ‘supported_operators’, ‘unsupported_operators’, ‘operators’, ‘operator_count’<a href="#id3"><span class="problematic" id="id4">``</span></a>.</p> </div></blockquote> </div> <div class="section" id="example-usage"> <h2>Example Usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">#</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">import</span> <span class="nn">tensorflow.neuron</span> <span class="k">as</span> <span class="nn">tfn</span> <span class="n">input0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Input</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="n">dense0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">3</span><span class="p">)(</span><span class="n">input0</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">Model</span><span class="p">(</span><span class="n">inputs</span><span class="o">=</span><span class="p">[</span><span class="n">input0</span><span class="p">],</span> <span class="n">outputs</span><span class="o">=</span><span class="p">[</span><span class="n">dense0</span><span class="p">])</span> <span class="n">example_inputs</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="n">results</span> <span class="o">=</span> <span class="n">tfn</span><span class="o">.</span><span class="n">analyze_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="n">results</span><span class="p">)</span> <span class="c1"># expected output</span> <span class="sd">'''</span> <span class="sd">BiasAdd</span> <span class="sd"> MatMul</span> <span class="sd"> 100.00% of all operations (2 of 2) are supported</span> <span class="sd"> {'percent_supported': 100.0, 'supported_count': 2, 'total_count': 2,</span> <span class="sd"> 'supported_operators': {'BiasAdd', 'MatMul'}, 'unsupported_operators': [],</span> <span class="sd"> 'operators': ['BiasAdd', 'MatMul'], 'operator_count': {'MatMul': 1, 'BiasAdd': 1}}</span> <span class="sd"> '''</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-tracing-python-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Tracing API</p> </div> </a> <a class="right-next" id="next-link" href="api-compilation-python-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow 1.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Compilation API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:19.231Z
TensorFlow 2.x (tensorflow-neuron) Tracing API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html
# TensorFlow 2.x (tensorflow-neuron) Tracing API — AWS Neuron Documentation ## Contents - [Method](#method) - [Description](#description) - [Arguments](#arguments) - [Special Flags](#special-flags) - [Returns](#returns) - [Example Usage](#example-usage) - [Example Usage with Manual Device Placement Using subgraph\_builder\_function](#example-usage-with-manual-device-placement-using-subgraph-builder-function) _This document is relevant for_: `Inf1` ## TensorFlow 2.x (`tensorflow-neuron`) Tracing API[#](#tensorflow-2-x-tensorflow-neuron-tracing-api "Permalink to this headline") The Neuron tracing API enables tracing TensorFlow 2.x models for deployment on AWS Machine Learning Accelerators. ## Method[#](#method "Permalink to this headline") `tensorflow.neuron.trace` ## Description[#](#description "Permalink to this headline") Trace a `keras.Model` or a Python callable that can be decorated by `tf.function`, and return an AWS-Neuron-optimized `keras.Model` that can execute on AWS Machine Learning Accelerators. Tracing is ideal for `keras.Model` that accepts a list of `tf.Tensor` objects and returns a list of `tf.Tensor` objects. It is expected that users will provide example inputs, and the `trace` function will execute `func` symbolically and convert it to a `keras.Model`. The returned `keras.Model` will support inference only. Attributes or variables held by the original function or `keras.Model` will be dropped. The returned `keras.Model` can be exported as SavedModel and served using TensorFlow Serving. Please see tensorflow-serving for more information about exporting to saved model and serving using TensorFlow Serving. The returned `keras.Model` has an `.on_neuron_ratio` attribute which shows the percentage of ops mapped to neuron hardware. This calculation ignores PlaceholerOp, IdentityOp, ReadVariableOp and NoOp. Options can be passed to Neuron compiler via the environment variable `NEURON_CC_FLAGS`. For example, the syntax `env NEURON_CC_FLAGS="--neuroncore-pipeline-cores=4"` directs Neuron compiler to compile each subgraph to fit in the specified number of NeuronCores. This number can be less than the total available NeuronCores on an Inf1 instance. See [Neuron compiler CLI Reference Guide (neuron-cc)](../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference) for more information about compiler options. ## Arguments[#](#arguments "Permalink to this headline") - **func:** The `keras.Model` or function to be traced. - **example\_inputs:** A `tf.Tensor` or a tuple/list/dict of `tf.Tensor` objects for tracing the function. When `example_inputs` is a `tf.Tensor` or a list of `tf.Tensor` objects, we expect `func` to have calling signature `func(example_inputs)`. Otherwise, the expectation is that inference on `func` is done by calling `func(*example_inputs)` when `example_inputs` is a `tuple`, or `func(**example_inputs)` when `example_inputs` is a `dict`. The case where `func` accepts mixed positional and keyword arguments is currently unsupported. - **subgraph\_builder\_function:** (Optional) A callable with signature `subgraph_builder_function(node : NodeDef) -> bool` (`NodeDef` is defined in tensorflow/core/framework/node\_def.proto) that is used as a call-back function to determine which part of the tensorflow GraphDef given by tracing `func` will be placed on Machine Learning Accelerators. If `subgraph_builder_function` is not provided, then `trace` will automatically place operations on Machine Learning Accelerators or on CPU to maximize the execution efficiency. If it is provided, and `subgraph_builder_function(node)` returns `True`, and placing `node` on Machine Learning Accelerators will not cause deadlocks during execution, then `trace` will place `node` on Machine Learning Accelerators. If `subgraph_builder_function(node)` returns `False`, then `trace` will place `node` on CPU. ## Special Flags[#](#special-flags "Permalink to this headline") These are flags that get passed directly to the Neuron tracing API (rather than the Neuron Compiler). The flags are still passed via the environment variable `NEURON_CC_FLAGS`. - **workdir:** example usage - `NEURON_CC_FLAGS='--workdir ./artifacts'` will create a folder named artifacts in the current directory and save artifacts that can be used for debug. - **dynamic-batch-size:** example usage - `NEURON_CC_FLAGS='--dynamic-batch-size'` A flag to allow Neuron graphs to consume variable sized batches of data. Dynamic sizing is restricted to the 0th dimension of a tensor. - **extract-weights (EXPERIMENTAL):** example usage - `NEURON_CC_FLAGS='--extract-weights inf1.2xlarge'` will reduce the compiled model’s protobuf size by taking the weights out of the protobuf. Useful for compiling large models that would exceed the 2GB protobuf size limit. This feature is experimental. Model performance is not guaranteed and the flag does not work in combination with `--neuroncore-pipeline-cores`, `--dynamic-batch-size`, models with multiple NEFFs, and models that are 4GB or greater. Compiles models for different neuron instances depending on the instance type passed. Supports all inf1 instance types. ## Returns[#](#returns "Permalink to this headline") - An AWS-Neuron-optimized `keras.Model`. ## Example Usage[#](#example-usage "Permalink to this headline") ``` import tensorflow as tf import tensorflow.neuron as tfn input0 = tf.keras.layers.Input(3) dense0 = tf.keras.layers.Dense(3)(input0) model = tf.keras.Model(inputs=[input0], outputs=[dense0]) example_inputs = tf.random.uniform([1, 3]) model_neuron = tfn.trace(model, example_inputs) # trace # check to see how much of the model was compiled successfully print(model_neuron.on_neuron_ratio) model_dir = './model_neuron' model_neuron.save(model_dir) model_neuron_reloaded = tf.keras.models.load_model(model_dir) ``` ## Example Usage with Manual Device Placement Using subgraph\_builder\_function[#](#example-usage-with-manual-device-placement-using-subgraph-builder-function "Permalink to this headline") ``` import tensorflow as tf import tensorflow.neuron as tfn input0 = tf.keras.layers.Input(3) dense0 = tf.keras.layers.Dense(3)(input0) reshape0 = tf.keras.layers.Reshape([1, 3])(dense0) output0 = tf.keras.layers.Dense(2)(reshape0) model = tf.keras.Model(inputs=[input0], outputs=[output0]) example_inputs = tf.random.uniform([1, 3]) def subgraph_builder_function(node): return node.op == 'MatMul' model_neuron = tfn.trace( model, example_inputs, subgraph_builder_function=subgraph_builder_function, ) ``` Important Although the old API `tensorflow.neuron.saved_model.compile` is still available under tensorflow-neuron 2.x, it supports only the limited capabilities of `tensorflow.neuron.trace` and will be deprecated in future releases. _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow 2.x (tensorflow-neuron) Tracing API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow 2.x (tensorflow-neuron) analyze_model API" href="api-tfn-analyze-model-api.html"> <link rel="prev" title="API Reference Guide (tensorflow-neuron)" href="api-reference-guide.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#special-flags"> Special Flags </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage-with-manual-device-placement-using-subgraph-builder-function"> Example Usage with Manual Device Placement Using <cite> subgraph_builder_function </cite> </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow 2.x (tensorflow-neuron) Tracing API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#special-flags"> Special Flags </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage-with-manual-device-placement-using-subgraph-builder-function"> Example Usage with Manual Device Placement Using <cite> subgraph_builder_function </cite> </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tensorflow-2-x-tensorflow-neuron-tracing-api"> <span id="tensorflow-ref-neuron-tracing-api"></span><h1>TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Tracing API<a class="headerlink" href="#tensorflow-2-x-tensorflow-neuron-tracing-api" title="Permalink to this headline">#</a></h1> <p>The Neuron tracing API enables tracing TensorFlow 2.x models for deployment on AWS Machine Learning Accelerators.</p> <div class="section" id="method"> <h2>Method<a class="headerlink" href="#method" title="Permalink to this headline">#</a></h2> <p><code class="docutils literal notranslate"><span class="pre">tensorflow.neuron.trace</span></code></p> </div> <div class="section" id="description"> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2> <p>Trace a <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or a Python callable that can be decorated by <code class="docutils literal notranslate"><span class="pre">tf.function</span></code>, and return an AWS-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> that can execute on AWS Machine Learning Accelerators. Tracing is ideal for <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> that accepts a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects and returns a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects. It is expected that users will provide example inputs, and the <code class="docutils literal notranslate"><span class="pre">trace</span></code> function will execute <code class="docutils literal notranslate"><span class="pre">func</span></code> symbolically and convert it to a <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code>.</p> <p>The returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will support inference only. Attributes or variables held by the original function or <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will be dropped.</p> <p>The returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> can be exported as SavedModel and served using TensorFlow Serving. Please see <span class="xref std std-ref">tensorflow-serving</span> for more information about exporting to saved model and serving using TensorFlow Serving.</p> <p>The returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> has an <code class="docutils literal notranslate"><span class="pre">.on_neuron_ratio</span></code> attribute which shows the percentage of ops mapped to neuron hardware. This calculation ignores PlaceholerOp, IdentityOp, ReadVariableOp and NoOp.</p> <p>Options can be passed to Neuron compiler via the environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code>. For example, the syntax <code class="docutils literal notranslate"><span class="pre">env</span> <span class="pre">NEURON_CC_FLAGS="--neuroncore-pipeline-cores=4"</span></code> directs Neuron compiler to compile each subgraph to fit in the specified number of NeuronCores. This number can be less than the total available NeuronCores on an Inf1 instance. See <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference"><span class="std std-ref">Neuron compiler CLI Reference Guide (neuron-cc)</span></a> for more information about compiler options.</p> </div> <div class="section" id="arguments"> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">#</a></h2> <ul> <li><p><strong>func:</strong> The <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or function to be traced.</p></li> <li><p><strong>example_inputs:</strong> A <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a tuple/list/dict of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects for tracing the function. When <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects, we expect <code class="docutils literal notranslate"><span class="pre">func</span></code> to have calling signature <code class="docutils literal notranslate"><span class="pre">func(example_inputs)</span></code>. Otherwise, the expectation is that inference on <code class="docutils literal notranslate"><span class="pre">func</span></code> is done by calling <code class="docutils literal notranslate"><span class="pre">func(*example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tuple</span></code>, or <code class="docutils literal notranslate"><span class="pre">func(**example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">dict</span></code>. The case where <code class="docutils literal notranslate"><span class="pre">func</span></code> accepts mixed positional and keyword arguments is currently unsupported.</p></li> <li><p><strong>subgraph_builder_function:</strong> (Optional) A callable with signature</p> <p><code class="docutils literal notranslate"><span class="pre">subgraph_builder_function(node</span> <span class="pre">:</span> <span class="pre">NodeDef)</span> <span class="pre">-&gt;</span> <span class="pre">bool</span></code> (<code class="docutils literal notranslate"><span class="pre">NodeDef</span></code> is defined in tensorflow/core/framework/node_def.proto)</p> <p>that is used as a call-back function to determine which part of the tensorflow GraphDef given by tracing <code class="docutils literal notranslate"><span class="pre">func</span></code> will be placed on Machine Learning Accelerators.</p> <p>If <code class="docutils literal notranslate"><span class="pre">subgraph_builder_function</span></code> is not provided, then <code class="docutils literal notranslate"><span class="pre">trace</span></code> will automatically place operations on Machine Learning Accelerators or on CPU to maximize the execution efficiency.</p> <p>If it is provided, and <code class="docutils literal notranslate"><span class="pre">subgraph_builder_function(node)</span></code> returns <code class="docutils literal notranslate"><span class="pre">True</span></code>, and placing <code class="docutils literal notranslate"><span class="pre">node</span></code> on Machine Learning Accelerators will not cause deadlocks during execution, then <code class="docutils literal notranslate"><span class="pre">trace</span></code> will place <code class="docutils literal notranslate"><span class="pre">node</span></code> on Machine Learning Accelerators. If <code class="docutils literal notranslate"><span class="pre">subgraph_builder_function(node)</span></code> returns <code class="docutils literal notranslate"><span class="pre">False</span></code>, then <code class="docutils literal notranslate"><span class="pre">trace</span></code> will place <code class="docutils literal notranslate"><span class="pre">node</span></code> on CPU.</p> </li> </ul> </div> <div class="section" id="special-flags"> <h2>Special Flags<a class="headerlink" href="#special-flags" title="Permalink to this headline">#</a></h2> <p>These are flags that get passed directly to the Neuron tracing API (rather than the Neuron Compiler). The flags are still passed via the environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS</span></code>.</p> <ul class="simple"> <li><p><strong>workdir:</strong> example usage - <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--workdir</span> <span class="pre">./artifacts'</span></code> will create a folder named artifacts in the current directory and save artifacts that can be used for debug.</p></li> <li><p><strong>dynamic-batch-size:</strong> example usage - <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--dynamic-batch-size'</span></code> A flag to allow Neuron graphs to consume variable sized batches of data. Dynamic sizing is restricted to the 0th dimension of a tensor.</p></li> <li><p><strong>extract-weights (EXPERIMENTAL):</strong> example usage - <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--extract-weights</span> <span class="pre">inf1.2xlarge'</span></code> will reduce the compiled model’s protobuf size by taking the weights out of the protobuf. Useful for compiling large models that would exceed the 2GB protobuf size limit. This feature is experimental. Model performance is not guaranteed and the flag does not work in combination with <code class="docutils literal notranslate"><span class="pre">--neuroncore-pipeline-cores</span></code>, <code class="docutils literal notranslate"><span class="pre">--dynamic-batch-size</span></code>, models with multiple NEFFs, and models that are 4GB or greater. Compiles models for different neuron instances depending on the instance type passed. Supports all inf1 instance types.</p></li> </ul> </div> <div class="section" id="returns"> <h2>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p>An AWS-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code>.</p></li> </ul> </div> <div class="section" id="example-usage"> <h2>Example Usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">#</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">import</span> <span class="nn">tensorflow.neuron</span> <span class="k">as</span> <span class="nn">tfn</span> <span class="n">input0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Input</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="n">dense0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">3</span><span class="p">)(</span><span class="n">input0</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">Model</span><span class="p">(</span><span class="n">inputs</span><span class="o">=</span><span class="p">[</span><span class="n">input0</span><span class="p">],</span> <span class="n">outputs</span><span class="o">=</span><span class="p">[</span><span class="n">dense0</span><span class="p">])</span> <span class="n">example_inputs</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">tfn</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">)</span> <span class="c1"># trace</span> <span class="c1"># check to see how much of the model was compiled successfully</span> <span class="nb">print</span><span class="p">(</span><span class="n">model_neuron</span><span class="o">.</span><span class="n">on_neuron_ratio</span><span class="p">)</span> <span class="n">model_dir</span> <span class="o">=</span> <span class="s1">'./model_neuron'</span> <span class="n">model_neuron</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">model_dir</span><span class="p">)</span> <span class="n">model_neuron_reloaded</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">load_model</span><span class="p">(</span><span class="n">model_dir</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="example-usage-with-manual-device-placement-using-subgraph-builder-function"> <h2>Example Usage with Manual Device Placement Using <cite>subgraph_builder_function</cite><a class="headerlink" href="#example-usage-with-manual-device-placement-using-subgraph-builder-function" title="Permalink to this headline">#</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span> <span class="kn">import</span> <span class="nn">tensorflow.neuron</span> <span class="k">as</span> <span class="nn">tfn</span> <span class="n">input0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Input</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="n">dense0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">3</span><span class="p">)(</span><span class="n">input0</span><span class="p">)</span> <span class="n">reshape0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Reshape</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])(</span><span class="n">dense0</span><span class="p">)</span> <span class="n">output0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">2</span><span class="p">)(</span><span class="n">reshape0</span><span class="p">)</span> <span class="n">model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">Model</span><span class="p">(</span><span class="n">inputs</span><span class="o">=</span><span class="p">[</span><span class="n">input0</span><span class="p">],</span> <span class="n">outputs</span><span class="o">=</span><span class="p">[</span><span class="n">output0</span><span class="p">])</span> <span class="n">example_inputs</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="k">def</span> <span class="nf">subgraph_builder_function</span><span class="p">(</span><span class="n">node</span><span class="p">):</span> <span class="k">return</span> <span class="n">node</span><span class="o">.</span><span class="n">op</span> <span class="o">==</span> <span class="s1">'MatMul'</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">tfn</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span> <span class="n">model</span><span class="p">,</span> <span class="n">example_inputs</span><span class="p">,</span> <span class="n">subgraph_builder_function</span><span class="o">=</span><span class="n">subgraph_builder_function</span><span class="p">,</span> <span class="p">)</span> </pre></div> </div> <div class="admonition important"> <p class="admonition-title">Important</p> <p>Although the old API <code class="docutils literal notranslate"><span class="pre">tensorflow.neuron.saved_model.compile</span></code> is still available under tensorflow-neuron 2.x, it supports only the limited capabilities of <code class="docutils literal notranslate"><span class="pre">tensorflow.neuron.trace</span></code> and will be deprecated in future releases.</p> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-reference-guide.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">API Reference Guide (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="api-tfn-analyze-model-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) analyze_model API</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:19.407Z
TensorFlow 1.x (tensorflow-neuron) Compilation API — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html
# TensorFlow 1.x (tensorflow-neuron) Compilation API — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf1` ## TensorFlow 1.x (`tensorflow-neuron`) Compilation API[#](#tensorflow-1-x-tensorflow-neuron-compilation-api "Permalink to this headline") The Neuron compilation API for TensorFlow 1.x enables compilation of saved model to an Inferentia target. ## Method[#](#method "Permalink to this headline") `tensorflow.neuron.saved_model.compile` ## Description[#](#description "Permalink to this headline") Within the graph or subgraph, the compile method selects and send Neuron-supported operations to Neuron-Compiler for compilation and saves the compiled artifacts in the graph. Uncompilable operations are kept as original operations for framework execution. The compiled graph can be exported to saved model and served using TensorFlow Serving. Please see tensorflow-serving for more information about exporting to saved model and serving using TensorFlow Serving. Options can be passed to Neuron compiler via the compile function. For example, the “`--neuroncore-pipeline-cores`” option directs Neuron compiler to compile each subgraph to fit in the specified number of NeuronCores. This number can be less than the total available NeuronCores on an Inf1 instance. See [Neuron compiler CLI Reference Guide (neuron-cc)](../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference) for more information about compiler options. ## Arguments[#](#arguments "Permalink to this headline") - **model\_dir:** The path of the original `SavedModel`. - **new\_model\_dir:** The path to which the Neuron-optimized `SavedModel` will be stored. - **batch\_size:** (Optional) Positive integer representing batch size used in inference. The default value is 1. - **model\_shape\_feed\_dict:** (Optional) Dictionary {str: list} used for inferring tensor shapes. Keys should match model input names. Values are lists of positive integers representing model input tensor shapes. - **model\_feed\_dict:** (Optional) Dictionary {str: numpy.array} used for inference. Useful for inferring tensor shapes. Keys should match model input names. Values are numpy arrays that can be fed as inputs to the `SavedModel`. - **tags:** (Optional) Iterable of strings to identify the required `MetaGraphDef`. These should correspond to the tags used when saving the variables using the `SavedModel` `save()` API. Default is to use the first `tag_set` available in the `SavedModel`. - **signature\_def\_key:** (Optional) String specifying the `signature_def` to use. Default is to use ‘serving\_default’ or the first `signature_def` corresponding to `tags`. - **minimum\_segment\_size:** (Optional) Integer indicating the minimum number of operations in an NeuronOp. - **no\_fuse\_ops:** (Optional) None or iterable of strings (unordered) representing names of operations that are forcibly placed on CPU. - **compiler\_args:** (Optional) List of strings representing neuron-cc compiler arguments. Note that these arguments apply to all subgraphs generated by whitelist partitioning. For example, use `compiler_args=['--neuroncore-pipeline-cores', '4']` to set number of NeuronCores per subgraph to 4. See [Neuron compiler CLI Reference Guide (neuron-cc)](../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference) for more information about compiler options. - **compiler\_workdir:** (Optional) String representing work directory of the neuron-cc compiler. ## Returns[#](#returns "Permalink to this headline") - Dictionary with operator counts before/after optimization. - Operator count statistics are displayed to show original count, post-optimization count, and the number placed on Neuron runtime. For example: ``` INFO:tensorflow:Number of operations in TensorFlow session: 3978 INFO:tensorflow:Number of operations after tf.neuron optimizations: 555 INFO:tensorflow:Number of operations placed on Neuron runtime: 554 ``` ## Example Usage[#](#example-usage "Permalink to this headline") ``` import shutil import tensorflow.neuron as tfn saved_model_path = "<saved model path>" compiled_saved_model_path = "<compiled saved model path>" shutil.rmtree(compiled_saved_model_path, ignore_errors=True) tfn.saved_model.compile(saved_model_path, compiled_saved_model_path) ``` _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow 1.x (tensorflow-neuron) Compilation API — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow Neuron (tensorflow-neuron) Auto Multicore Replication (Experimental)" href="api-auto-replication-api.html"> <link rel="prev" title="TensorFlow 2.x (tensorflow-neuron) analyze_model API" href="api-tfn-analyze-model-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow 1.x (tensorflow-neuron) Compilation API</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-usage"> Example Usage </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tensorflow-1-x-tensorflow-neuron-compilation-api"> <span id="tensorflow-ref-neuron-compile-api"></span><h1>TensorFlow 1.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Compilation API<a class="headerlink" href="#tensorflow-1-x-tensorflow-neuron-compilation-api" title="Permalink to this headline">#</a></h1> <p>The Neuron compilation API for TensorFlow 1.x enables compilation of saved model to an Inferentia target.</p> <div class="section" id="method"> <h2>Method<a class="headerlink" href="#method" title="Permalink to this headline">#</a></h2> <p><code class="docutils literal notranslate"><span class="pre">tensorflow.neuron.saved_model.compile</span></code></p> </div> <div class="section" id="description"> <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2> <p>Within the graph or subgraph, the compile method selects and send Neuron-supported operations to Neuron-Compiler for compilation and saves the compiled artifacts in the graph. Uncompilable operations are kept as original operations for framework execution.</p> <p>The compiled graph can be exported to saved model and served using TensorFlow Serving. Please see <span class="xref std std-ref">tensorflow-serving</span> for more information about exporting to saved model and serving using TensorFlow Serving.</p> <p>Options can be passed to Neuron compiler via the compile function. For example, the “<code class="docutils literal notranslate"><span class="pre">--neuroncore-pipeline-cores</span></code>” option directs Neuron compiler to compile each subgraph to fit in the specified number of NeuronCores. This number can be less than the total available NeuronCores on an Inf1 instance. See <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference"><span class="std std-ref">Neuron compiler CLI Reference Guide (neuron-cc)</span></a> for more information about compiler options.</p> </div> <div class="section" id="arguments"> <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p><strong>model_dir:</strong> The path of the original <code class="docutils literal notranslate"><span class="pre">SavedModel</span></code>.</p></li> <li><p><strong>new_model_dir:</strong> The path to which the Neuron-optimized <code class="docutils literal notranslate"><span class="pre">SavedModel</span></code> will be stored.</p></li> <li><p><strong>batch_size:</strong> (Optional) Positive integer representing batch size used in inference. The default value is 1.</p></li> <li><p><strong>model_shape_feed_dict:</strong> (Optional) Dictionary {str: list} used for inferring tensor shapes. Keys should match model input names. Values are lists of positive integers representing model input tensor shapes.</p></li> <li><p><strong>model_feed_dict:</strong> (Optional) Dictionary {str: numpy.array} used for inference. Useful for inferring tensor shapes. Keys should match model input names. Values are numpy arrays that can be fed as inputs to the <code class="docutils literal notranslate"><span class="pre">SavedModel</span></code>.</p></li> <li><p><strong>tags:</strong> (Optional) Iterable of strings to identify the required <code class="docutils literal notranslate"><span class="pre">MetaGraphDef</span></code>. These should correspond to the tags used when saving the variables using the <code class="docutils literal notranslate"><span class="pre">SavedModel</span></code> <code class="docutils literal notranslate"><span class="pre">save()</span></code> API. Default is to use the first <code class="docutils literal notranslate"><span class="pre">tag_set</span></code> available in the <code class="docutils literal notranslate"><span class="pre">SavedModel</span></code>.</p></li> <li><p><strong>signature_def_key:</strong> (Optional) String specifying the <code class="docutils literal notranslate"><span class="pre">signature_def</span></code> to use. Default is to use ‘serving_default’ or the first <code class="docutils literal notranslate"><span class="pre">signature_def</span></code> corresponding to <code class="docutils literal notranslate"><span class="pre">tags</span></code>.</p></li> <li><p><strong>minimum_segment_size:</strong> (Optional) Integer indicating the minimum number of operations in an NeuronOp.</p></li> <li><p><strong>no_fuse_ops:</strong> (Optional) None or iterable of strings (unordered) representing names of operations that are forcibly placed on CPU.</p></li> <li><p><strong>compiler_args:</strong> (Optional) List of strings representing neuron-cc compiler arguments. Note that these arguments apply to all subgraphs generated by whitelist partitioning. For example, use <code class="docutils literal notranslate"><span class="pre">compiler_args=['--neuroncore-pipeline-cores',</span> <span class="pre">'4']</span></code> to set number of NeuronCores per subgraph to 4. See <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference"><span class="std std-ref">Neuron compiler CLI Reference Guide (neuron-cc)</span></a> for more information about compiler options.</p></li> <li><p><strong>compiler_workdir:</strong> (Optional) String representing work directory of the neuron-cc compiler.</p></li> </ul> </div> <div class="section" id="returns"> <h2>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p>Dictionary with operator counts before/after optimization.</p></li> <li><p>Operator count statistics are displayed to show original count, post-optimization count, and the number placed on Neuron runtime. For example:</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">INFO</span><span class="p">:</span><span class="n">tensorflow</span><span class="p">:</span><span class="n">Number</span> <span class="n">of</span> <span class="n">operations</span> <span class="ow">in</span> <span class="n">TensorFlow</span> <span class="n">session</span><span class="p">:</span> <span class="mi">3978</span> <span class="n">INFO</span><span class="p">:</span><span class="n">tensorflow</span><span class="p">:</span><span class="n">Number</span> <span class="n">of</span> <span class="n">operations</span> <span class="n">after</span> <span class="n">tf</span><span class="o">.</span><span class="n">neuron</span> <span class="n">optimizations</span><span class="p">:</span> <span class="mi">555</span> <span class="n">INFO</span><span class="p">:</span><span class="n">tensorflow</span><span class="p">:</span><span class="n">Number</span> <span class="n">of</span> <span class="n">operations</span> <span class="n">placed</span> <span class="n">on</span> <span class="n">Neuron</span> <span class="n">runtime</span><span class="p">:</span> <span class="mi">554</span> </pre></div> </div> </div> <div class="section" id="example-usage"> <h2>Example Usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">#</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">shutil</span> <span class="kn">import</span> <span class="nn">tensorflow.neuron</span> <span class="k">as</span> <span class="nn">tfn</span> <span class="n">saved_model_path</span> <span class="o">=</span> <span class="s2">"&lt;saved model path&gt;"</span> <span class="n">compiled_saved_model_path</span> <span class="o">=</span> <span class="s2">"&lt;compiled saved model path&gt;"</span> <span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">compiled_saved_model_path</span><span class="p">,</span> <span class="n">ignore_errors</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="n">tfn</span><span class="o">.</span><span class="n">saved_model</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">saved_model_path</span><span class="p">,</span> <span class="n">compiled_saved_model_path</span><span class="p">)</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-tfn-analyze-model-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) analyze_model API</p> </div> </a> <a class="right-next" id="next-link" href="api-auto-replication-api.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Auto Multicore Replication (Experimental)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:19.793Z
TensorFlow Neuron (tensorflow-neuron) Auto Multicore Replication (Experimental) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html
# TensorFlow Neuron (tensorflow-neuron) Auto Multicore Replication (Experimental) — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## TensorFlow Neuron (`tensorflow-neuron`) Auto Multicore Replication (Experimental)[#](#tensorflow-neuron-tensorflow-neuron-auto-multicore-replication-experimental "Permalink to this headline") The Neuron auto multicore replication Python API enables modifying TensorFlow 2.x traced models so that they can be automatically replicated across multiple cores. For Tensorflow-Serving models and TensorFlow 1.x models, see [TensorFlow Neuron TF2.x (tensorflow-neuronx TF2.x) Auto Multicore Replication CLI (Experimental)](../tensorflow-neuronx/tf-neuronx-auto-replication-api.html#tensorflow-ref-auto-replication-cli-api) Table of contents - [TensorFlow Neuron TF 2.x (`tensorflow-neuron TF2.x`) Auto Multicore Replication Python API (Experimental)](#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental) - [TensorFlow Neuron TF1.x/TF2.x (`tensorflow-neuron TF1.x/TF2.x`) Auto Multicore Replication CLI (Experimental)](#tensorflow-neuron-tf1-x-tf2-x-tensorflow-neuron-tf1-x-tf2-x-auto-multicore-replication-cli-experimental) ## [TensorFlow Neuron TF 2.x (`tensorflow-neuron TF2.x`) Auto Multicore Replication Python API (Experimental)](#id3)[#](#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental "Permalink to this headline") ### Method[#](#method "Permalink to this headline") `tensorflow.neuron.auto_multicore` ### Description[#](#description "Permalink to this headline") Converts an existing AWS-Neuron-optimized `keras.Model` and returns an auto-replication tagged AWS-Multicore-Neuron-optimized `keras.Model` that can execute on AWS Machine Learning Accelerators. Like the traced model, the returned `keras.Model` will support inference only. Attributes or variables held by the original function or `keras.Model` will be dropped. The auto model replication feature in TensorFlow-Neuron enables you to create a model once and the model parallel replication would happen automatically. The desired number of cores can be less than the total available NeuronCores on an Inf1 instance but not less than 1. This reduces framework memory usage as you are not loading the same model multiple times manually. Calls to the returned model will execute the call on each core in a round-robin fashion. The returned `keras.Model` can be exported as SavedModel and served using TensorFlow Serving. Please see tensorflow-serving for more information about exporting to saved model and serving using TensorFlow Serving. Note that the automatic replication will only work on models compiled with pipeline size 1: via `--neuroncore-pipeline-cores=1`. If auto replication is not enabled, the model will default to replicate on up to 4 cores. See [Neuron compiler CLI Reference Guide (neuron-cc)](../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference) for more information about compiler options. ### Arguments[#](#arguments "Permalink to this headline") - **func:** The `keras.Model` or function to be traced. - **example\_inputs:** A `tf.Tensor` or a tuple/list/dict of `tf.Tensor` objects for tracing the function. When `example_inputs` is a `tf.Tensor` or a list of `tf.Tensor` objects, we expect `func` to have calling signature `func(example_inputs)`. Otherwise, the expectation is that inference on `func` is done by calling `func(*example_inputs)` when `example_inputs` is a `tuple`, or `func(**example_inputs)` when `example_inputs` is a `dict`. The case where `func` accepts mixed positional and keyword arguments is currently unsupported. - **num\_cores:** The desired number of cores where the model will be automatically replicated across ### Returns[#](#returns "Permalink to this headline") - An AWS-Multicore-Neuron-optimized `keras.Model`. ### Example Python API Usage for TF2.x traced models:[#](#example-python-api-usage-for-tf2-x-traced-models "Permalink to this headline") ``` input0 = tf.keras.layers.Input(3) dense0 = tf.keras.layers.Dense(3)(input0) inputs = [input0] outputs = [dense0] model = tf.keras.Model(inputs=inputs, outputs=outputs) input0_tensor = tf.random.uniform([1, 3]) model_neuron = tfn.trace(model, input0_tensor) num_cores = 4 multicore_model = tfn.auto_multicore(model_neuron, input0_tensor, num_cores=num_cores) multicore_model(input0_tensor) ``` ### Example Python API Usage for TF2.x saved models:[#](#example-python-api-usage-for-tf2-x-saved-models "Permalink to this headline") ``` from tensorflow.python import saved_model input0_tensor = tf.random.uniform([1, 3]) num_cores = 4 reload_model = saved_model.load(model_dir) multicore_model = tfn.auto_multicore(reload_model, input0_tensor, num_cores=num_cores) ``` ## [TensorFlow Neuron TF1.x/TF2.x (`tensorflow-neuron TF1.x/TF2.x`) Auto Multicore Replication CLI (Experimental)](#id4)[#](#tensorflow-neuron-tf1-x-tf2-x-tensorflow-neuron-tf1-x-tf2-x-auto-multicore-replication-cli-experimental "Permalink to this headline") The Neuron auto multicore replication CLI enables modifying TensorFlow 1.x and Tensorflow 2.x traced saved models so that they can be automatically replicated across multiple cores. By performing this call on Tensorflow Saved Models, we can support both Tensorflow-Serving and Tensorflow 1.x without significant modifications to the code. Note that the python API does not support Tensorflow 1.x. ### Method[#](#id1 "Permalink to this headline") `tf-neuron-auto-multicore MODEL_DIR --num_cores NUM_CORES --new_model_dir NEW_MODEL_DIR` ### Arguments[#](#id2 "Permalink to this headline") - **MODEL\_DIR:** The directory of a saved AWS-Neuron-optimized `keras.Model`. - **NUM\_CORES:** The desired number of cores where the model will be automatically replicated across - **NEW\_MODEL\_DIR:** The directory of where the AWS-Multicore-Neuron-optimized `keras.Model` will be saved ### Example CLI Usage for TF 1.x and Tensorflow-Serving saved models:[#](#example-cli-usage-for-tf-1-x-and-tensorflow-serving-saved-models "Permalink to this headline") ``` tf-neuron-auto-multicore ./resnet --num_cores 8 --new_model_dir ./modified_resnet ``` _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow Neuron (tensorflow-neuron) Auto Multicore Replication (Experimental) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="Misc (tensorflow-neuron)" href="misc-tensorflow-neuron.html"> <link rel="prev" title="TensorFlow 1.x (tensorflow-neuron) Compilation API" href="api-compilation-python-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental"> TensorFlow Neuron TF 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> TF2.x </span> </code> ) Auto Multicore Replication Python API (Experimental) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-python-api-usage-for-tf2-x-traced-models"> Example Python API Usage for TF2.x traced models: </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-python-api-usage-for-tf2-x-saved-models"> Example Python API Usage for TF2.x saved models: </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-tf1-x-tf2-x-tensorflow-neuron-tf1-x-tf2-x-auto-multicore-replication-cli-experimental"> TensorFlow Neuron TF1.x/TF2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> TF1.x/TF2.x </span> </code> ) Auto Multicore Replication CLI (Experimental) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Method </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> Arguments </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-cli-usage-for-tf-1-x-and-tensorflow-serving-saved-models"> Example CLI Usage for TF 1.x and Tensorflow-Serving saved models: </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow Neuron (tensorflow-neuron) Auto Multicore Replication (Experimental)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental"> TensorFlow Neuron TF 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> TF2.x </span> </code> ) Auto Multicore Replication Python API (Experimental) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#method"> Method </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#description"> Description </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#arguments"> Arguments </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#returns"> Returns </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-python-api-usage-for-tf2-x-traced-models"> Example Python API Usage for TF2.x traced models: </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-python-api-usage-for-tf2-x-saved-models"> Example Python API Usage for TF2.x saved models: </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-tf1-x-tf2-x-tensorflow-neuron-tf1-x-tf2-x-auto-multicore-replication-cli-experimental"> TensorFlow Neuron TF1.x/TF2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> TF1.x/TF2.x </span> </code> ) Auto Multicore Replication CLI (Experimental) </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> Method </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> Arguments </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#example-cli-usage-for-tf-1-x-and-tensorflow-serving-saved-models"> Example CLI Usage for TF 1.x and Tensorflow-Serving saved models: </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tensorflow-neuron-tensorflow-neuron-auto-multicore-replication-experimental"> <span id="tensorflow-ref-auto-replication-python-api"></span><h1>TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Auto Multicore Replication (Experimental)<a class="headerlink" href="#tensorflow-neuron-tensorflow-neuron-auto-multicore-replication-experimental" title="Permalink to this headline">#</a></h1> <p>The Neuron auto multicore replication Python API enables modifying TensorFlow 2.x traced models so that they can be automatically replicated across multiple cores. For Tensorflow-Serving models and TensorFlow 1.x models, see <a class="reference internal" href="../tensorflow-neuronx/tf-neuronx-auto-replication-api.html#tensorflow-ref-auto-replication-cli-api"><span class="std std-ref">TensorFlow Neuron TF2.x (tensorflow-neuronx TF2.x) Auto Multicore Replication CLI (Experimental)</span></a></p> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental" id="id3">TensorFlow Neuron TF 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">TF2.x</span></code>) Auto Multicore Replication Python API (Experimental)</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-tf1-x-tf2-x-tensorflow-neuron-tf1-x-tf2-x-auto-multicore-replication-cli-experimental" id="id4">TensorFlow Neuron TF1.x/TF2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">TF1.x/TF2.x</span></code>) Auto Multicore Replication CLI (Experimental)</a></p></li> </ul> </div> <div class="section" id="tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental"> <h2><a class="toc-backref" href="#id3">TensorFlow Neuron TF 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">TF2.x</span></code>) Auto Multicore Replication Python API (Experimental)</a><a class="headerlink" href="#tensorflow-neuron-tf-2-x-tensorflow-neuron-tf2-x-auto-multicore-replication-python-api-experimental" title="Permalink to this headline">#</a></h2> <div class="section" id="method"> <h3>Method<a class="headerlink" href="#method" title="Permalink to this headline">#</a></h3> <p><code class="docutils literal notranslate"><span class="pre">tensorflow.neuron.auto_multicore</span></code></p> </div> <div class="section" id="description"> <h3>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h3> <p>Converts an existing AWS-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> and returns an auto-replication tagged AWS-Multicore-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> that can execute on AWS Machine Learning Accelerators. Like the traced model, the returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will support inference only. Attributes or variables held by the original function or <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will be dropped.</p> <p>The auto model replication feature in TensorFlow-Neuron enables you to create a model once and the model parallel replication would happen automatically. The desired number of cores can be less than the total available NeuronCores on an Inf1 instance but not less than 1. This reduces framework memory usage as you are not loading the same model multiple times manually. Calls to the returned model will execute the call on each core in a round-robin fashion.</p> <p>The returned <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> can be exported as SavedModel and served using TensorFlow Serving. Please see <span class="xref std std-ref">tensorflow-serving</span> for more information about exporting to saved model and serving using TensorFlow Serving.</p> <p>Note that the automatic replication will only work on models compiled with pipeline size 1: via <code class="docutils literal notranslate"><span class="pre">--neuroncore-pipeline-cores=1</span></code>. If auto replication is not enabled, the model will default to replicate on up to 4 cores.</p> <p>See <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html#neuron-compiler-cli-reference"><span class="std std-ref">Neuron compiler CLI Reference Guide (neuron-cc)</span></a> for more information about compiler options.</p> </div> <div class="section" id="arguments"> <h3>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p><strong>func:</strong> The <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> or function to be traced.</p></li> <li><p><strong>example_inputs:</strong> A <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a tuple/list/dict of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects for tracing the function. When <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> or a list of <code class="docutils literal notranslate"><span class="pre">tf.Tensor</span></code> objects, we expect <code class="docutils literal notranslate"><span class="pre">func</span></code> to have calling signature <code class="docutils literal notranslate"><span class="pre">func(example_inputs)</span></code>. Otherwise, the expectation is that inference on <code class="docutils literal notranslate"><span class="pre">func</span></code> is done by calling <code class="docutils literal notranslate"><span class="pre">func(*example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">tuple</span></code>, or <code class="docutils literal notranslate"><span class="pre">func(**example_inputs)</span></code> when <code class="docutils literal notranslate"><span class="pre">example_inputs</span></code> is a <code class="docutils literal notranslate"><span class="pre">dict</span></code>. The case where <code class="docutils literal notranslate"><span class="pre">func</span></code> accepts mixed positional and keyword arguments is currently unsupported.</p></li> <li><p><strong>num_cores:</strong> The desired number of cores where the model will be automatically replicated across</p></li> </ul> </div> <div class="section" id="returns"> <h3>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>An AWS-Multicore-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code>.</p></li> </ul> </div> <div class="section" id="example-python-api-usage-for-tf2-x-traced-models"> <h3>Example Python API Usage for TF2.x traced models:<a class="headerlink" href="#example-python-api-usage-for-tf2-x-traced-models" title="Permalink to this headline">#</a></h3> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">input0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Input</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="n">dense0</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">layers</span><span class="o">.</span><span class="n">Dense</span><span class="p">(</span><span class="mi">3</span><span class="p">)(</span><span class="n">input0</span><span class="p">)</span> <span class="n">inputs</span> <span class="o">=</span> <span class="p">[</span><span class="n">input0</span><span class="p">]</span> <span class="n">outputs</span> <span class="o">=</span> <span class="p">[</span><span class="n">dense0</span><span class="p">]</span> <span class="n">model</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">Model</span><span class="p">(</span><span class="n">inputs</span><span class="o">=</span><span class="n">inputs</span><span class="p">,</span> <span class="n">outputs</span><span class="o">=</span><span class="n">outputs</span><span class="p">)</span> <span class="n">input0_tensor</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="n">model_neuron</span> <span class="o">=</span> <span class="n">tfn</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">input0_tensor</span><span class="p">)</span> <span class="n">num_cores</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">multicore_model</span> <span class="o">=</span> <span class="n">tfn</span><span class="o">.</span><span class="n">auto_multicore</span><span class="p">(</span><span class="n">model_neuron</span><span class="p">,</span> <span class="n">input0_tensor</span><span class="p">,</span> <span class="n">num_cores</span><span class="o">=</span><span class="n">num_cores</span><span class="p">)</span> <span class="n">multicore_model</span><span class="p">(</span><span class="n">input0_tensor</span><span class="p">)</span> </pre></div> </div> </div> <div class="section" id="example-python-api-usage-for-tf2-x-saved-models"> <h3>Example Python API Usage for TF2.x saved models:<a class="headerlink" href="#example-python-api-usage-for-tf2-x-saved-models" title="Permalink to this headline">#</a></h3> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">tensorflow.python</span> <span class="kn">import</span> <span class="n">saved_model</span> <span class="n">input0_tensor</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span> <span class="n">num_cores</span> <span class="o">=</span> <span class="mi">4</span> <span class="n">reload_model</span> <span class="o">=</span> <span class="n">saved_model</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">model_dir</span><span class="p">)</span> <span class="n">multicore_model</span> <span class="o">=</span> <span class="n">tfn</span><span class="o">.</span><span class="n">auto_multicore</span><span class="p">(</span><span class="n">reload_model</span><span class="p">,</span> <span class="n">input0_tensor</span><span class="p">,</span> <span class="n">num_cores</span><span class="o">=</span><span class="n">num_cores</span><span class="p">)</span> </pre></div> </div> </div> </div> <div class="section" id="tensorflow-neuron-tf1-x-tf2-x-tensorflow-neuron-tf1-x-tf2-x-auto-multicore-replication-cli-experimental"> <span id="tensorflow-ref-auto-replication-cli-api"></span><h2><a class="toc-backref" href="#id4">TensorFlow Neuron TF1.x/TF2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">TF1.x/TF2.x</span></code>) Auto Multicore Replication CLI (Experimental)</a><a class="headerlink" href="#tensorflow-neuron-tf1-x-tf2-x-tensorflow-neuron-tf1-x-tf2-x-auto-multicore-replication-cli-experimental" title="Permalink to this headline">#</a></h2> <p>The Neuron auto multicore replication CLI enables modifying TensorFlow 1.x and Tensorflow 2.x traced saved models so that they can be automatically replicated across multiple cores. By performing this call on Tensorflow Saved Models, we can support both Tensorflow-Serving and Tensorflow 1.x without significant modifications to the code. Note that the python API does not support Tensorflow 1.x.</p> <div class="section" id="id1"> <h3>Method<a class="headerlink" href="#id1" title="Permalink to this headline">#</a></h3> <p><code class="docutils literal notranslate"><span class="pre">tf-neuron-auto-multicore</span> <span class="pre">MODEL_DIR</span> <span class="pre">--num_cores</span> <span class="pre">NUM_CORES</span> <span class="pre">--new_model_dir</span> <span class="pre">NEW_MODEL_DIR</span></code></p> </div> <div class="section" id="id2"> <h3>Arguments<a class="headerlink" href="#id2" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p><strong>MODEL_DIR:</strong> The directory of a saved AWS-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code>.</p></li> <li><p><strong>NUM_CORES:</strong> The desired number of cores where the model will be automatically replicated across</p></li> <li><p><strong>NEW_MODEL_DIR:</strong> The directory of where the AWS-Multicore-Neuron-optimized <code class="docutils literal notranslate"><span class="pre">keras.Model</span></code> will be saved</p></li> </ul> </div> <div class="section" id="example-cli-usage-for-tf-1-x-and-tensorflow-serving-saved-models"> <h3>Example CLI Usage for TF 1.x and Tensorflow-Serving saved models:<a class="headerlink" href="#example-cli-usage-for-tf-1-x-and-tensorflow-serving-saved-models" title="Permalink to this headline">#</a></h3> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">tf</span><span class="o">-</span><span class="n">neuron</span><span class="o">-</span><span class="n">auto</span><span class="o">-</span><span class="n">multicore</span> <span class="o">./</span><span class="n">resnet</span> <span class="o">--</span><span class="n">num_cores</span> <span class="mi">8</span> <span class="o">--</span><span class="n">new_model_dir</span> <span class="o">./</span><span class="n">modified_resnet</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-compilation-python-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow 1.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Compilation API</p> </div> </a> <a class="right-next" id="next-link" href="misc-tensorflow-neuron.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Misc (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:19.956Z
TensorFlow Neuron (tensorflow-neuron (TF1.x)) Release Notes — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html
# TensorFlow Neuron (tensorflow-neuron (TF1.x)) Release Notes — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## TensorFlow Neuron (`tensorflow-neuron (TF1.x)`) Release Notes[#](#tensorflow-neuron-tensorflow-neuron-tf1-x-release-notes "Permalink to this headline") Table of contents - [Known Issues and Limitations - updated 08/12/2021](#known-issues-and-limitations-updated-08-12-2021) - [tensorflow-neuron 1.x release \[2.10.1.0\]](#tensorflow-neuron-1-x-release-2-10-1-0) - [tensorflow-neuron 1.x release \[2.9.0.0\]](#tensorflow-neuron-1-x-release-2-9-0-0) - [tensorflow-neuron 1.x release \[2.8.9.0\]](#tensorflow-neuron-1-x-release-2-8-9-0) - [tensorflow-neuron 1.x release \[2.8.1.0\]](#tensorflow-neuron-1-x-release-2-8-1-0) - [tensorflow-neuron 1.x release \[2.7.3.0\]](#tensorflow-neuron-1-x-release-2-7-3-0) - [tensorflow-neuron 1.x release \[2.6.5.0\]](#tensorflow-neuron-1-x-release-2-6-5-0) - [tensorflow-neuron 1.x release \[2.4.0.0\]](#tensorflow-neuron-1-x-release-2-4-0-0) - [tensorflow-neuron 1.x release \[2.3.0.0\]](#tensorflow-neuron-1-x-release-2-3-0-0) - [tensorflow-neuron 1.x release \[2.1.14.0\]](#tensorflow-neuron-1-x-release-2-1-14-0) - [tensorflow-neuron 1.x release \[2.1.14.0\]](#id1) - [tensorflow-neuron 1.x release \[2.1.13.0\]](#tensorflow-neuron-1-x-release-2-1-13-0) - [tensorflow-neuron 1.x release \[2.1.6.0\]](#tensorflow-neuron-1-x-release-2-1-6-0) - [tensorflow-neuron 1.x release \[2.0.4.0\]](#tensorflow-neuron-1-x-release-2-0-4-0) - [tensorflow-neuron 1.x release \[2.0.3.0\]](#tensorflow-neuron-1-x-release-2-0-3-0) - [\[1.15.5.1.5.1.0\]](#id2) - [\[1.15.5.1.4.0.0\]](#id5) - [\[1.15.5.1.3.3.0\]](#id8) - [\[1.15.5.1.2.9.0\]](#id11) - [\[1.15.5.1.2.8.0\]](#id14) - [\[1.15.5.1.2.2.0\]](#id17) - [\[1.15.4.1.1.3.0\]](#id20) - [\[1.15.4.1.0.2168.0\]](#id23) - [\[1.15.3.1.0.2043.0\]](#id26) - [\[1.15.3.1.0.1965.0\]](#id29) - [\[1.15.3.1.0.1953.0\]](#id32) - [\[1.15.3.1.0.1891.0\]](#id35) - [\[1.15.2.1.0.1796.0\]](#id39) - [\[1.15.2.1.0.1572.0\]](#id43) - [\[1.15.0.1.0.1333.0\]](#id49) - [\[1.15.0.1.0.1240.0\]](#id55) - [\[1.15.0.1.0.997.0\]](#id61) - [\[1.15.0.1.0.803.0\]](#id68) - [\[1.15.0.1.0.749.0\]](#id75) - [\[1.15.0.1.0.663.0\]](#id82) This document lists the release notes for the tensorflow-neuron 1.x package. ## [Known Issues and Limitations - updated 08/12/2021](#id88)[#](#known-issues-and-limitations-updated-08-12-2021 "Permalink to this headline") - Support on serialized TensorFlow 2.x custom operators is currently limited. Serializing some operators registered from TensorFlow-text through [TensorFlow Hub](https://tfhub.dev/) is going to cause failure in tensorflow.neuron.trace. - Issue: When compiling large models, user might run out of memory and encounter this fatal error. ``` terminate called after throwing an instance of 'std::bad_alloc' ``` Solution: run compilation on a c5.4xlarge instance type or larger. - Issue: When upgrading `tensorflow-neuron` with `pip install tensorflow-neuron --upgrade`, the following error message may appear, which is caused by `pip` version being too low. ``` Could not find a version that satisfies the requirement TensorFlow<1.16.0,>=1.15.0 (from tensorflow-neuron) ``` Solution: run a `pip install pip --upgrade` before upgrading `tensorflow-neuron`. - Issue: Some Keras routines throws the following error: ``` AttributeError: 'str' object has no attribute 'decode'. ``` Solution: Please downgrade h5py by pip install ‘h5py<3’. This is caused by [https://github.com/TensorFlow/TensorFlow/issues/44467](https://github.com/TensorFlow/TensorFlow/issues/44467). ## [tensorflow-neuron 1.x release \[2.10.1.0\]](#id89)[#](#tensorflow-neuron-1-x-release-2-10-1-0 "Permalink to this headline") Date: 8/28/2023 - Minor updates ## [tensorflow-neuron 1.x release \[2.9.0.0\]](#id90)[#](#tensorflow-neuron-1-x-release-2-9-0-0 "Permalink to this headline") Date: 7/19/2023 - Minor updates ## [tensorflow-neuron 1.x release \[2.8.9.0\]](#id91)[#](#tensorflow-neuron-1-x-release-2-8-9-0 "Permalink to this headline") Date: 6/14/2023 - Minor updates ## [tensorflow-neuron 1.x release \[2.8.1.0\]](#id92)[#](#tensorflow-neuron-1-x-release-2-8-1-0 "Permalink to this headline") Date: 5/1/2023 - Minor updates ## [tensorflow-neuron 1.x release \[2.7.3.0\]](#id93)[#](#tensorflow-neuron-1-x-release-2-7-3-0 "Permalink to this headline") Date: 3/28/2023 - Minor updates ## [tensorflow-neuron 1.x release \[2.6.5.0\]](#id94)[#](#tensorflow-neuron-1-x-release-2-6-5-0 "Permalink to this headline") Date: 2/24/2023 - Added support for TensorFlow versions 2.9 and 2.10 - End-of-support for TensorFlow versions 2.5 and 2.6 ## [tensorflow-neuron 1.x release \[2.4.0.0\]](#id95)[#](#tensorflow-neuron-1-x-release-2-4-0-0 "Permalink to this headline") Date: 11/23/2022 - Introduce `tf-neuron-auto-multicore` tool to enable automatic data parallel on multiple NeuronCores. - Deprecated the NEURONCORE\_GROUP\_SIZES environment variable. - Minor bug fixes. ## [tensorflow-neuron 1.x release \[2.3.0.0\]](#id96)[#](#tensorflow-neuron-1-x-release-2-3-0-0 "Permalink to this headline") Date: 04/29/2022 - Minor bug fixes. ## [tensorflow-neuron 1.x release \[2.1.14.0\]](#id97)[#](#tensorflow-neuron-1-x-release-2-1-14-0 "Permalink to this headline") Date: 03/25/2022 - Minor bug fixes. ## [tensorflow-neuron 1.x release \[2.1.14.0\]](#id98)[#](#id1 "Permalink to this headline") Date: 02/17/2022 - Minor bug fixes. ## [tensorflow-neuron 1.x release \[2.1.13.0\]](#id99)[#](#tensorflow-neuron-1-x-release-2-1-13-0 "Permalink to this headline") Date: 02/16/2022 - Fixed a bug that caused a memory leak. The memory leak was approximately 128b for each inference and exists in all versions of TensorFlow Neuron versions part of Neuron 1.16.0 to Neuron 1.17.0 releases. see [Previous Releases Artifacts (Neuron 2.x)](../../prev/content.html#pre-release-content) for exact versions included in each release. ## [tensorflow-neuron 1.x release \[2.0.4.0\]](#id101)[#](#tensorflow-neuron-1-x-release-2-0-4-0 "Permalink to this headline") Date: 11/05/2021 - Updated Neuron Runtime (which is integrated within this package) to `libnrt 2.2.18.0` to fix a container issue that was preventing the use of containers when /dev/neuron0 was not present. See details here neuron-runtime-release-notes. ## [tensorflow-neuron 1.x release \[2.0.3.0\]](#id102)[#](#tensorflow-neuron-1-x-release-2-0-3-0 "Permalink to this headline") Date: 10/27/2021 ### New in this release[#](#new-in-this-release "Permalink to this headline") - TensorFlow 1.x (`tensorflow-neuron`) now support Neuron Runtime 2.x (`libnrt.so` shared library) only. > Important > > - You must update to the latest Neuron Driver (`aws-neuron-dkms` version 2.1 or newer) for proper functionality of the new runtime library. > > - Read [Introducing Neuron Runtime 2.x (libnrt.so)](../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt) application note that describes [why are we making this change](../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-why) and how [this change will affect the Neuron SDK](../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-how-sdk) in detail. > > - Read [Migrate your application to Neuron Runtime 2.x (libnrt.so)](../../../general/appnotes/neuron1x/introducing-libnrt.html#neuron-migrating-apps-neuron-to-libnrt) for detailed information of how to migrate your application. > ### Resolved Issues[#](#resolved-issues "Permalink to this headline") - Fix neuron-cc argument handling bug when nothing can be compiled. - Fixing the support of cast operators applied after constants, by Introducing support of constant-folding pass before Neuron auto-mixed-precision. ## [\[1.15.5.1.5.1.0\]](#id103)[#](#id2 "Permalink to this headline") Date: 07/02/2021 ### New in this release[#](#id4 "Permalink to this headline") - Bug fixes regarding scalar inputs/outputs. - Minor performance improvements when dynamic batch size is turned on or when model is small. ## [\[1.15.5.1.4.0.0\]](#id104)[#](#id5 "Permalink to this headline") Date: 05/28/2021 ### New in this release[#](#id7 "Permalink to this headline") - Reduce the amount of input/output data movement during inference. - Improve parallelism for dynamic batch size inference by adopting a new sharding mechanism. - Reduce the amount of host memory usage during inference. - tfn.saved\_model.compile now generates correct code when operator Split is used as output. - tfn.saved\_model.compile now properly reads input tensor shape information from SignatureDef proto. - tfn.saved\_model.compile now terminates properly when neuron-cc compiler argument is passed but there is no successful compilation. - Fix bug on some wrong internal tensor names when neuron-cc compiler crashes. - Other minor bug fixes. ## [\[1.15.5.1.3.3.0\]](#id105)[#](#id8 "Permalink to this headline") Date: 05/01/2021 ### New in this release[#](#id10 "Permalink to this headline") 1. Minor enhancements. ## [\[1.15.5.1.2.9.0\]](#id106)[#](#id11 "Permalink to this headline") Date: 03/04/2021 ### New in this release[#](#id13 "Permalink to this headline") 1. Minor enhancements. ## [\[1.15.5.1.2.8.0\]](#id107)[#](#id14 "Permalink to this headline") Date: 02/24/2021 ### New in this release[#](#id16 "Permalink to this headline") 1. Fix for CVE-2021-3177. ## [\[1.15.5.1.2.2.0\]](#id108)[#](#id17 "Permalink to this headline") Date: 01/30/2021 ### New in this release[#](#id19 "Permalink to this headline") 1. Bug fixes and internal refactor. 2. Bump TensorFlow base package version to 1.15.5. 3. Introduced a new argument `convert_constants_to_variables` to the compilation API `tfn.saved_model.compile`. Setting it to `True` can address the issue of large constants consuming too much memory in the TensorFlow runtime. ## [\[1.15.4.1.1.3.0\]](#id109)[#](#id20 "Permalink to this headline") Date: 12/23/2020 ### New in this release[#](#id22 "Permalink to this headline") 1. Improved logging during tfn.saved\_model.compile to display neuron-cc compilation progress. 2. Small performance improvement in some edge cases by optimizing the NeuronCore-executable assignment mechanism. ## [\[1.15.4.1.0.2168.0\]](#id110)[#](#id23 "Permalink to this headline") Date: 11/17/2020 ### New in this release[#](#id25 "Permalink to this headline") 1. tensorflow-neuron is now a plugin package that can be used together with TensorFlow~=1.15.0 built with `GLIBCXX_USE_CXX11_ABI=0`. 2. Improved logging during `tfn.saved_model.compile` to display `neuron-cc` logging file path, which is useful for tracking `neuron-cc` compilation progress. 3. Small performance improvement by utilizing shared memory more efficiently. ## [\[1.15.3.1.0.2043.0\]](#id111)[#](#id26 "Permalink to this headline") Date: 09/22/2020 ### New in this release[#](#id28 "Permalink to this headline") 1. tensorflow-neuron now automatically enables data parallel mode on four cores in one Inferentia. In `TensorFlow-model-server-neuron`, most models can now fully utilize four cores automatically. In Python TensorFlow, running threaded inference using `>=4` Python threads in the same TensorFlow Session lead to full utilization of four cores. 2. tensorflow-neuron now tries to enable dynamic batch size automatically for a limited number of models, such as ResNet50. 3. Improved logging during `tfn.saved_model.compile` to display input/output information about subgraphs that are going to be compiled by `neuron-cc`. ## [\[1.15.3.1.0.1965.0\]](#id112)[#](#id29 "Permalink to this headline") Date: 08/08/2020 ### New in this release[#](#summary-1 "Permalink to this headline") Various minor improvements. ## [\[1.15.3.1.0.1953.0\]](#id113)[#](#id32 "Permalink to this headline") Date: 08/05/2020 ### New in this release[#](#summary-2 "Permalink to this headline") Various minor improvements. ## [\[1.15.3.1.0.1891.0\]](#id114)[#](#id35 "Permalink to this headline") Date: 07/16/2020 ### New in this release[#](#summary-3 "Permalink to this headline") This version contains a few bug fixes and user experience improvements. ### Dependency change[#](#dependency-change "Permalink to this headline") 1. Bump TensorFlow base package version number to 1.15.3 2. Add `TensorFlow >= 1.15.0, < 1.16.0` as an installation dependency so that packages depending on TensorFlow can be installed together with tensorflow-neuron without error ### New Features[#](#new-features "Permalink to this headline") 1. `tensorflow-neuron` now displays a summary of model performance when profiling is enable by setting environment variable `NEURON_PROFILE` ### Resolved Issues[#](#id38 "Permalink to this headline") 1. Environment variable `NEURON_PROFILE` can now be set to a non-existing path which will be automatically created 2. Fixed a bug in `tfn.saved_model.compile` that causes compilation failure when `dynamic_batch_size=True` is specified on a SavedModel with unknown rank inputs. ## [\[1.15.2.1.0.1796.0\]](#id115)[#](#id39 "Permalink to this headline") Date 6/11/2020 ### New in this release[#](#summary-4 "Permalink to this headline") This version contains a few bug fixes. ### Major New Features[#](#major-new-features "Permalink to this headline") ### Resolved Issues[#](#resolved-issues-1 "Permalink to this headline") 1. Fixed a bug related with device placement. Now models with device information hardcoded to GPU can be successfully compiled with `tfn.saved_model.compile` 2. Fixed a bug in `tfn.saved_model.compile` that causes models containing Reshape operators not functioning correctly when it is compiled with `dynamic_batch_size=True` 3. Fixed a bug in `tfn.saved_model.compile` that causes models containing Table related operators to initialize incorrectly after compilation. ### Known Issues and limitations[#](#known-issues-and-limitations "Permalink to this headline") ## [\[1.15.2.1.0.1572.0\]](#id116)[#](#id43 "Permalink to this headline") Date: 5/11/2020 ### New in this release[#](#summary-5 "Permalink to this headline") This version contains some bug fixes and new features. ### Major New Features[#](#major-new-features-1 "Permalink to this headline") - tensorflow-neuron is now built on TensorFlow 1.15.2 instead of TensorFlow 1.15.0 ### Resolved Issues[#](#resolved-issues-2 "Permalink to this headline") - Fixed a bug that caused Neuron runtime resources to not all be released when a tensorflow-neuron process terminated with in-flight inferences - Inference timeout value set at compile time is now correctly recognized at runtime ### Known Issues and limitations[#](#id48 "Permalink to this headline") ## [\[1.15.0.1.0.1333.0\]](#id117)[#](#id49 "Permalink to this headline") Date: 3/26/2020 ### New in this release[#](#summary-6 "Permalink to this headline") ### Major New Features[#](#major-new-features-2 "Permalink to this headline") - Improved performance between TensorFlow to Neuron runtime. ### Resolved Issues[#](#resolved-issues-3 "Permalink to this headline") - Fixed a bug in Neuron runtime adaptor operator’s shape function when dynamic batch size inference is enabled - Framework method (tensorflow.neuron.saved-model.compile) improved handling of compiler timeout termination by letting it clean up before exiting. ### Known Issues and limitations[#](#known-issues-and-limitations-2 "Permalink to this headline") ## [\[1.15.0.1.0.1240.0\]](#id118)[#](#id55 "Permalink to this headline") Date: 2/27/2020 ### New in this release[#](#summary-7 "Permalink to this headline") ### Major New Features[#](#major-new-features-3 "Permalink to this headline") - Enabled runtime memory optimizations by default to improve inference performance, specifically in cases with large input/output tensors - tfn.saved\_model.compile now displays warning message instead of “successfully compiled” if less than 30% of operators are mapped to Inferentia - Improve error messages. Runtime failure error messages are now more descriptive and also provide instructions to restart neuron-rtd when necessary. ### Resolved Issues[#](#resolved-issues-4 "Permalink to this headline") ### Known Issues and Limitations[#](#known-issues-and-limitations-3 "Permalink to this headline") - Issue: When compiling a large model, may encounter. ``` terminate called after throwing an instance of 'std::bad_alloc' ``` Solution: run compilation on c5.4xlarge instance type or larger. ### Other Notes[#](#other-notes "Permalink to this headline") ## [\[1.15.0.1.0.997.0\]](#id119)[#](#id61 "Permalink to this headline") Date: 1/27/2020 ### New in this release[#](#summary-8 "Permalink to this headline") ### Major New Features[#](#major-new-features-4 "Permalink to this headline") - Added support for NCHW pooling operators in tfn.saved\_model.compile. ### Resolved Issues[#](#resolved-issues-5 "Permalink to this headline") - Fixed GRPC transient status error issue. - Fixed a graph partitioner issue with control inputs. ### Known Issues and Limitations[#](#known-issues-and-limitations-4 "Permalink to this headline") - Issue: When compiling a large model, may encounter. ``` terminate called after throwing an instance of 'std::bad_alloc' ``` Solution: run compilation on c5.4xlarge instance type or larger. ### Other Notes[#](#other-notes-1 "Permalink to this headline") ## [\[1.15.0.1.0.803.0\]](#id120)[#](#id68 "Permalink to this headline") Date: 12/20/2019 ### New in this release[#](#summary-9 "Permalink to this headline") ### Major New Features[#](#major-new-features-5 "Permalink to this headline") ### Resolved Issues[#](#resolved-issues-6 "Permalink to this headline") - Improved handling of `tf.neuron.saved_model.compile` arguments ### Known Issues and Limitations[#](#known-issues-and-limitations-5 "Permalink to this headline") ### Other Notes[#](#other-notes-2 "Permalink to this headline") ## [\[1.15.0.1.0.749.0\]](#id121)[#](#id75 "Permalink to this headline") Date: 12/1/2019 ### New in this release[#](#summary-10 "Permalink to this headline") ### Major New Features[#](#major-new-features-6 "Permalink to this headline") ### Resolved Issues[#](#resolved-issues-7 "Permalink to this headline") - Fix race condition between model load and model unload when the process is killed - Remove unnecessary GRPC calls when the process is killed ### Known Issues and Limitations[#](#known-issues-and-limitations-6 "Permalink to this headline") - When compiling a large model, may encounter “terminate called after throwing an instance of ‘std::bad\_alloc’”. Solution: run compilation on c5.4xlarge instance type or larger. - The pip package `wrapt` may have a conflicting version in some installations. This is seen when this error occurs: ``` ERROR: Cannot uninstall 'wrapt'. It is a distutils installed project and thus we cannot accurately determine which files belong to it which would lead to only a partial uninstall. ``` To solve this, you can update wrapt to the newer version: ``` python3 -m pip install wrapt --ignore-installed python3 -m pip install tensorflow-neuron ``` Within a Conda environment: ``` conda update wrapt conda update tensorflow-neuron ``` ### Other Notes[#](#other-notes-3 "Permalink to this headline") ## [\[1.15.0.1.0.663.0\]](#id122)[#](#id82 "Permalink to this headline") Date: 11/25/2019 ### New in this release[#](#summary-11 "Permalink to this headline") This version is available only in released DLAMI v26.0 and is based on TensorFlow version 1.15.0. Please update to latest version. ### Major New Features[#](#major-new-features-7 "Permalink to this headline") ### Resolved Issues[#](#resolved-issues-8 "Permalink to this headline") ### Known Issues and Limits[#](#known-issues-and-limits "Permalink to this headline") ### Models Supported[#](#models-supported "Permalink to this headline") The following models have successfully run on neuron-inferentia systems 1. BERT\_LARGE and BERT\_BASE 2. Transformer 3. Resnet50 V1/V2 4. Inception-V2/V3/V4 ### Other Notes[#](#other-notes-4 "Permalink to this headline") - Python versions supported: - 3.5, 3.6, 3.7 - Linux distribution supported: - Ubuntu 18, Amazon Linux 2 _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow Neuron (tensorflow-neuron (TF1.x)) Release Notes — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow Neuron (tensorflow-neuron (TF2.x)) Release Notes" href="tensorflow-neuron-v2.html"> <link rel="prev" title="Misc (tensorflow-neuron)" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Frelease-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-updated-08-12-2021"> Known Issues and Limitations - updated 08/12/2021 </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-10-1-0"> tensorflow-neuron 1.x release [2.10.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-9-0-0"> tensorflow-neuron 1.x release [2.9.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-8-9-0"> tensorflow-neuron 1.x release [2.8.9.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-8-1-0"> tensorflow-neuron 1.x release [2.8.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-7-3-0"> tensorflow-neuron 1.x release [2.7.3.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-6-5-0"> tensorflow-neuron 1.x release [2.6.5.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-4-0-0"> tensorflow-neuron 1.x release [2.4.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-3-0-0"> tensorflow-neuron 1.x release [2.3.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-1-14-0"> tensorflow-neuron 1.x release [2.1.14.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> tensorflow-neuron 1.x release [2.1.14.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-1-13-0"> tensorflow-neuron 1.x release [2.1.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-1-6-0"> tensorflow-neuron 1.x release [2.1.6.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-0-4-0"> tensorflow-neuron 1.x release [2.0.4.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-0-3-0"> tensorflow-neuron 1.x release [2.0.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#new-in-this-release"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> [1.15.5.1.5.1.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id4"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id5"> [1.15.5.1.4.0.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id7"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id8"> [1.15.5.1.3.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id10"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id11"> [1.15.5.1.2.9.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id13"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id14"> [1.15.5.1.2.8.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id16"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id17"> [1.15.5.1.2.2.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id19"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id20"> [1.15.4.1.1.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id22"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id23"> [1.15.4.1.0.2168.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id25"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id26"> [1.15.3.1.0.2043.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id28"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id29"> [1.15.3.1.0.1965.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-1"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id32"> [1.15.3.1.0.1953.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-2"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id35"> [1.15.3.1.0.1891.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-3"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dependency-change"> Dependency change </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#new-features"> New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id38"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id39"> [1.15.2.1.0.1796.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-4"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-1"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known Issues and limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id43"> [1.15.2.1.0.1572.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-5"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-1"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-2"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id48"> Known Issues and limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id49"> [1.15.0.1.0.1333.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-6"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-2"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-3"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-2"> Known Issues and limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id55"> [1.15.0.1.0.1240.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-7"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-3"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-4"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-3"> Known Issues and Limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id61"> [1.15.0.1.0.997.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-8"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-4"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-5"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-4"> Known Issues and Limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-1"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id68"> [1.15.0.1.0.803.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-9"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-5"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-6"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-5"> Known Issues and Limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-2"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id75"> [1.15.0.1.0.749.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-10"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-6"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-7"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-6"> Known Issues and Limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-3"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id82"> [1.15.0.1.0.663.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-11"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-7"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-8"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limits"> Known Issues and Limits </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#models-supported"> Models Supported </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-4"> Other Notes </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow Neuron (tensorflow-neuron (TF1.x)) Release Notes</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-updated-08-12-2021"> Known Issues and Limitations - updated 08/12/2021 </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-10-1-0"> tensorflow-neuron 1.x release [2.10.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-9-0-0"> tensorflow-neuron 1.x release [2.9.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-8-9-0"> tensorflow-neuron 1.x release [2.8.9.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-8-1-0"> tensorflow-neuron 1.x release [2.8.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-7-3-0"> tensorflow-neuron 1.x release [2.7.3.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-6-5-0"> tensorflow-neuron 1.x release [2.6.5.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-4-0-0"> tensorflow-neuron 1.x release [2.4.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-3-0-0"> tensorflow-neuron 1.x release [2.3.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-1-14-0"> tensorflow-neuron 1.x release [2.1.14.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id1"> tensorflow-neuron 1.x release [2.1.14.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-1-13-0"> tensorflow-neuron 1.x release [2.1.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-1-6-0"> tensorflow-neuron 1.x release [2.1.6.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-0-4-0"> tensorflow-neuron 1.x release [2.0.4.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-1-x-release-2-0-3-0"> tensorflow-neuron 1.x release [2.0.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#new-in-this-release"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> [1.15.5.1.5.1.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id4"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id5"> [1.15.5.1.4.0.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id7"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id8"> [1.15.5.1.3.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id10"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id11"> [1.15.5.1.2.9.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id13"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id14"> [1.15.5.1.2.8.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id16"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id17"> [1.15.5.1.2.2.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id19"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id20"> [1.15.4.1.1.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id22"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id23"> [1.15.4.1.0.2168.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id25"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id26"> [1.15.3.1.0.2043.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id28"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id29"> [1.15.3.1.0.1965.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-1"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id32"> [1.15.3.1.0.1953.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-2"> New in this release </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id35"> [1.15.3.1.0.1891.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-3"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#dependency-change"> Dependency change </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#new-features"> New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id38"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id39"> [1.15.2.1.0.1796.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-4"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-1"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations"> Known Issues and limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id43"> [1.15.2.1.0.1572.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-5"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-1"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-2"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id48"> Known Issues and limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id49"> [1.15.0.1.0.1333.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-6"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-2"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-3"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-2"> Known Issues and limitations </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id55"> [1.15.0.1.0.1240.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-7"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-3"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-4"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-3"> Known Issues and Limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id61"> [1.15.0.1.0.997.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-8"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-4"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-5"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-4"> Known Issues and Limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-1"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id68"> [1.15.0.1.0.803.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-9"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-5"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-6"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-5"> Known Issues and Limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-2"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id75"> [1.15.0.1.0.749.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-10"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-6"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-7"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-6"> Known Issues and Limitations </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-3"> Other Notes </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#id82"> [1.15.0.1.0.663.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#summary-11"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#major-new-features-7"> Major New Features </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues-8"> Resolved Issues </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limits"> Known Issues and Limits </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#models-supported"> Models Supported </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#other-notes-4"> Other Notes </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tensorflow-neuron-tensorflow-neuron-tf1-x-release-notes"> <span id="tensorflow-neuron-release-notes"></span><span id="tensorflow-neuron-rn"></span><h1>TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF1.x)</span></code>) Release Notes<a class="headerlink" href="#tensorflow-neuron-tensorflow-neuron-tf1-x-release-notes" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#known-issues-and-limitations-updated-08-12-2021" id="id88">Known Issues and Limitations - updated 08/12/2021</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-10-1-0" id="id89">tensorflow-neuron 1.x release [2.10.1.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-9-0-0" id="id90">tensorflow-neuron 1.x release [2.9.0.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-8-9-0" id="id91">tensorflow-neuron 1.x release [2.8.9.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-8-1-0" id="id92">tensorflow-neuron 1.x release [2.8.1.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-7-3-0" id="id93">tensorflow-neuron 1.x release [2.7.3.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-6-5-0" id="id94">tensorflow-neuron 1.x release [2.6.5.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-4-0-0" id="id95">tensorflow-neuron 1.x release [2.4.0.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-3-0-0" id="id96">tensorflow-neuron 1.x release [2.3.0.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-1-14-0" id="id97">tensorflow-neuron 1.x release [2.1.14.0]</a></p></li> <li><p><a class="reference internal" href="#id1" id="id98">tensorflow-neuron 1.x release [2.1.14.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-1-13-0" id="id99">tensorflow-neuron 1.x release [2.1.13.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-1-6-0" id="id100">tensorflow-neuron 1.x release [2.1.6.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-0-4-0" id="id101">tensorflow-neuron 1.x release [2.0.4.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-1-x-release-2-0-3-0" id="id102">tensorflow-neuron 1.x release [2.0.3.0]</a></p></li> <li><p><a class="reference internal" href="#id2" id="id103">[1.15.5.1.5.1.0]</a></p></li> <li><p><a class="reference internal" href="#id5" id="id104">[1.15.5.1.4.0.0]</a></p></li> <li><p><a class="reference internal" href="#id8" id="id105">[1.15.5.1.3.3.0]</a></p></li> <li><p><a class="reference internal" href="#id11" id="id106">[1.15.5.1.2.9.0]</a></p></li> <li><p><a class="reference internal" href="#id14" id="id107">[1.15.5.1.2.8.0]</a></p></li> <li><p><a class="reference internal" href="#id17" id="id108">[1.15.5.1.2.2.0]</a></p></li> <li><p><a class="reference internal" href="#id20" id="id109">[1.15.4.1.1.3.0]</a></p></li> <li><p><a class="reference internal" href="#id23" id="id110">[1.15.4.1.0.2168.0]</a></p></li> <li><p><a class="reference internal" href="#id26" id="id111">[1.15.3.1.0.2043.0]</a></p></li> <li><p><a class="reference internal" href="#id29" id="id112">[1.15.3.1.0.1965.0]</a></p></li> <li><p><a class="reference internal" href="#id32" id="id113">[1.15.3.1.0.1953.0]</a></p></li> <li><p><a class="reference internal" href="#id35" id="id114">[1.15.3.1.0.1891.0]</a></p></li> <li><p><a class="reference internal" href="#id39" id="id115">[1.15.2.1.0.1796.0]</a></p></li> <li><p><a class="reference internal" href="#id43" id="id116">[1.15.2.1.0.1572.0]</a></p></li> <li><p><a class="reference internal" href="#id49" id="id117">[1.15.0.1.0.1333.0]</a></p></li> <li><p><a class="reference internal" href="#id55" id="id118">[1.15.0.1.0.1240.0]</a></p></li> <li><p><a class="reference internal" href="#id61" id="id119">[1.15.0.1.0.997.0]</a></p></li> <li><p><a class="reference internal" href="#id68" id="id120">[1.15.0.1.0.803.0]</a></p></li> <li><p><a class="reference internal" href="#id75" id="id121">[1.15.0.1.0.749.0]</a></p></li> <li><p><a class="reference internal" href="#id82" id="id122">[1.15.0.1.0.663.0]</a></p></li> </ul> </div> <p>This document lists the release notes for the tensorflow-neuron 1.x package.</p> <div class="section" id="known-issues-and-limitations-updated-08-12-2021"> <span id="tf-known-issues-and-limitations"></span><h2><a class="toc-backref" href="#id88">Known Issues and Limitations - updated 08/12/2021</a><a class="headerlink" href="#known-issues-and-limitations-updated-08-12-2021" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p>Support on serialized TensorFlow 2.x custom operators is currently limited. Serializing some operators registered from TensorFlow-text through <a class="reference external" href="https://tfhub.dev/">TensorFlow Hub</a> is going to cause failure in tensorflow.neuron.trace.</p></li> <li><p>Issue: When compiling large models, user might run out of memory and encounter this fatal error.</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">terminate</span> <span class="n">called</span> <span class="n">after</span> <span class="n">throwing</span> <span class="n">an</span> <span class="n">instance</span> <span class="n">of</span> <span class="s1">'std::bad_alloc'</span> </pre></div> </div> <p>Solution: run compilation on a c5.4xlarge instance type or larger.</p> <ul class="simple"> <li><p>Issue: When upgrading <code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code> with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">tensorflow-neuron</span> <span class="pre">--upgrade</span></code>, the following error message may appear, which is caused by <code class="docutils literal notranslate"><span class="pre">pip</span></code> version being too low.</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Could</span> <span class="ow">not</span> <span class="n">find</span> <span class="n">a</span> <span class="n">version</span> <span class="n">that</span> <span class="n">satisfies</span> <span class="n">the</span> <span class="n">requirement</span> <span class="n">TensorFlow</span><span class="o">&lt;</span><span class="mf">1.16.0</span><span class="p">,</span><span class="o">&gt;=</span><span class="mf">1.15.0</span> <span class="p">(</span><span class="kn">from</span> <span class="nn">tensorflow</span><span class="o">-</span><span class="n">neuron</span><span class="p">)</span> </pre></div> </div> <p>Solution: run a <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pip</span> <span class="pre">--upgrade</span></code> before upgrading <code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>.</p> <ul class="simple"> <li><p>Issue: Some Keras routines throws the following error:</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ne">AttributeError</span><span class="p">:</span> <span class="s1">'str'</span> <span class="nb">object</span> <span class="n">has</span> <span class="n">no</span> <span class="n">attribute</span> <span class="s1">'decode'</span><span class="o">.</span> </pre></div> </div> <p>Solution: Please downgrade <cite>h5py</cite> by <cite>pip install ‘h5py&lt;3’</cite>. This is caused by <a class="reference external" href="https://github.com/TensorFlow/TensorFlow/issues/44467">https://github.com/TensorFlow/TensorFlow/issues/44467</a>.</p> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-10-1-0"> <h2><a class="toc-backref" href="#id89">tensorflow-neuron 1.x release [2.10.1.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-10-1-0" title="Permalink to this headline">#</a></h2> <p>Date: 8/28/2023</p> <ul class="simple"> <li><p>Minor updates</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-9-0-0"> <h2><a class="toc-backref" href="#id90">tensorflow-neuron 1.x release [2.9.0.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-9-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 7/19/2023</p> <ul class="simple"> <li><p>Minor updates</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-8-9-0"> <h2><a class="toc-backref" href="#id91">tensorflow-neuron 1.x release [2.8.9.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-8-9-0" title="Permalink to this headline">#</a></h2> <p>Date: 6/14/2023</p> <ul class="simple"> <li><p>Minor updates</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-8-1-0"> <h2><a class="toc-backref" href="#id92">tensorflow-neuron 1.x release [2.8.1.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-8-1-0" title="Permalink to this headline">#</a></h2> <p>Date: 5/1/2023</p> <ul class="simple"> <li><p>Minor updates</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-7-3-0"> <h2><a class="toc-backref" href="#id93">tensorflow-neuron 1.x release [2.7.3.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-7-3-0" title="Permalink to this headline">#</a></h2> <p>Date: 3/28/2023</p> <ul class="simple"> <li><p>Minor updates</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-6-5-0"> <h2><a class="toc-backref" href="#id94">tensorflow-neuron 1.x release [2.6.5.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-6-5-0" title="Permalink to this headline">#</a></h2> <p>Date: 2/24/2023</p> <ul class="simple"> <li><p>Added support for TensorFlow versions 2.9 and 2.10</p></li> <li><p>End-of-support for TensorFlow versions 2.5 and 2.6</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-4-0-0"> <h2><a class="toc-backref" href="#id95">tensorflow-neuron 1.x release [2.4.0.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-4-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 11/23/2022</p> <ul class="simple"> <li><p>Introduce <code class="docutils literal notranslate"><span class="pre">tf-neuron-auto-multicore</span></code> tool to enable automatic data parallel on multiple NeuronCores.</p></li> <li><p>Deprecated the NEURONCORE_GROUP_SIZES environment variable.</p></li> <li><p>Minor bug fixes.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-3-0-0"> <h2><a class="toc-backref" href="#id96">tensorflow-neuron 1.x release [2.3.0.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-3-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 04/29/2022</p> <ul class="simple"> <li><p>Minor bug fixes.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-1-14-0"> <h2><a class="toc-backref" href="#id97">tensorflow-neuron 1.x release [2.1.14.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-1-14-0" title="Permalink to this headline">#</a></h2> <p>Date: 03/25/2022</p> <ul class="simple"> <li><p>Minor bug fixes.</p></li> </ul> </div> <div class="section" id="id1"> <h2><a class="toc-backref" href="#id98">tensorflow-neuron 1.x release [2.1.14.0]</a><a class="headerlink" href="#id1" title="Permalink to this headline">#</a></h2> <p>Date: 02/17/2022</p> <ul class="simple"> <li><p>Minor bug fixes.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-1-13-0"> <h2><a class="toc-backref" href="#id99">tensorflow-neuron 1.x release [2.1.13.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-1-13-0" title="Permalink to this headline">#</a></h2> <p>Date: 02/16/2022</p> <ul class="simple"> <li><p>Fixed a bug that caused a memory leak. The memory leak was approximately 128b for each inference and exists in all versions of TensorFlow Neuron versions part of Neuron 1.16.0 to Neuron 1.17.0 releases. see <a class="reference internal" href="../../prev/content.html#pre-release-content"><span class="std std-ref">Previous Releases Artifacts (Neuron 2.x)</span></a> for exact versions included in each release.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-1-6-0"> <h2><a class="toc-backref" href="#id100">tensorflow-neuron 1.x release [2.1.6.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-1-6-0" title="Permalink to this headline">#</a></h2> <p>Date: 01/20/2022</p> <ul class="simple"> <li><p>Enhanced auto data parallel (e.g. when using NEURONCORE_GROUP_SIZES=X,Y,Z,W) to support edge cases.</p></li> <li><p>Added new operators support. see <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html#neuron-cc-ops-tensorflow"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators</span></a>.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-0-4-0"> <h2><a class="toc-backref" href="#id101">tensorflow-neuron 1.x release [2.0.4.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-0-4-0" title="Permalink to this headline">#</a></h2> <p>Date: 11/05/2021</p> <ul class="simple"> <li><p>Updated Neuron Runtime (which is integrated within this package) to <code class="docutils literal notranslate"><span class="pre">libnrt</span> <span class="pre">2.2.18.0</span></code> to fix a container issue that was preventing the use of containers when /dev/neuron0 was not present. See details here <span class="xref std std-ref">neuron-runtime-release-notes</span>.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-1-x-release-2-0-3-0"> <h2><a class="toc-backref" href="#id102">tensorflow-neuron 1.x release [2.0.3.0]</a><a class="headerlink" href="#tensorflow-neuron-1-x-release-2-0-3-0" title="Permalink to this headline">#</a></h2> <p>Date: 10/27/2021</p> <div class="section" id="new-in-this-release"> <h3>New in this release<a class="headerlink" href="#new-in-this-release" title="Permalink to this headline">#</a></h3> <ul> <li><p>TensorFlow 1.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) now support Neuron Runtime 2.x (<code class="docutils literal notranslate"><span class="pre">libnrt.so</span></code> shared library) only.</p> <blockquote> <div><div class="admonition important"> <p class="admonition-title">Important</p> <ul class="simple"> <li><p>You must update to the latest Neuron Driver (<code class="docutils literal notranslate"><span class="pre">aws-neuron-dkms</span></code> version 2.1 or newer) for proper functionality of the new runtime library.</p></li> <li><p>Read <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt"><span class="std std-ref">Introducing Neuron Runtime 2.x (libnrt.so)</span></a> application note that describes <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-why"><span class="std std-ref">why are we making this change</span></a> and how <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-how-sdk"><span class="std std-ref">this change will affect the Neuron SDK</span></a> in detail.</p></li> <li><p>Read <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#neuron-migrating-apps-neuron-to-libnrt"><span class="std std-ref">Migrate your application to Neuron Runtime 2.x (libnrt.so)</span></a> for detailed information of how to migrate your application.</p></li> </ul> </div> </div></blockquote> </li> </ul> </div> <div class="section" id="resolved-issues"> <h3>Resolved Issues<a class="headerlink" href="#resolved-issues" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fix neuron-cc argument handling bug when nothing can be compiled.</p></li> <li><p>Fixing the support of cast operators applied after constants, by Introducing support of constant-folding pass before Neuron auto-mixed-precision.</p></li> </ul> </div> </div> <div class="section" id="id2"> <span id="id3"></span><h2><a class="toc-backref" href="#id103">[1.15.5.1.5.1.0]</a><a class="headerlink" href="#id2" title="Permalink to this headline">#</a></h2> <p>Date: 07/02/2021</p> <div class="section" id="id4"> <h3>New in this release<a class="headerlink" href="#id4" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Bug fixes regarding scalar inputs/outputs.</p></li> <li><p>Minor performance improvements when dynamic batch size is turned on or when model is small.</p></li> </ul> </div> </div> <div class="section" id="id5"> <span id="id6"></span><h2><a class="toc-backref" href="#id104">[1.15.5.1.4.0.0]</a><a class="headerlink" href="#id5" title="Permalink to this headline">#</a></h2> <p>Date: 05/28/2021</p> <div class="section" id="id7"> <h3>New in this release<a class="headerlink" href="#id7" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Reduce the amount of input/output data movement during inference.</p></li> <li><p>Improve parallelism for dynamic batch size inference by adopting a new sharding mechanism.</p></li> <li><p>Reduce the amount of host memory usage during inference.</p></li> <li><p>tfn.saved_model.compile now generates correct code when operator Split is used as output.</p></li> <li><p>tfn.saved_model.compile now properly reads input tensor shape information from SignatureDef proto.</p></li> <li><p>tfn.saved_model.compile now terminates properly when neuron-cc compiler argument is passed but there is no successful compilation.</p></li> <li><p>Fix bug on some wrong internal tensor names when neuron-cc compiler crashes.</p></li> <li><p>Other minor bug fixes.</p></li> </ul> </div> </div> <div class="section" id="id8"> <span id="id9"></span><h2><a class="toc-backref" href="#id105">[1.15.5.1.3.3.0]</a><a class="headerlink" href="#id8" title="Permalink to this headline">#</a></h2> <p>Date: 05/01/2021</p> <div class="section" id="id10"> <h3>New in this release<a class="headerlink" href="#id10" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Minor enhancements.</p></li> </ol> </div> </div> <div class="section" id="id11"> <span id="id12"></span><h2><a class="toc-backref" href="#id106">[1.15.5.1.2.9.0]</a><a class="headerlink" href="#id11" title="Permalink to this headline">#</a></h2> <p>Date: 03/04/2021</p> <div class="section" id="id13"> <h3>New in this release<a class="headerlink" href="#id13" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Minor enhancements.</p></li> </ol> </div> </div> <div class="section" id="id14"> <span id="id15"></span><h2><a class="toc-backref" href="#id107">[1.15.5.1.2.8.0]</a><a class="headerlink" href="#id14" title="Permalink to this headline">#</a></h2> <p>Date: 02/24/2021</p> <div class="section" id="id16"> <h3>New in this release<a class="headerlink" href="#id16" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Fix for CVE-2021-3177.</p></li> </ol> </div> </div> <div class="section" id="id17"> <span id="id18"></span><h2><a class="toc-backref" href="#id108">[1.15.5.1.2.2.0]</a><a class="headerlink" href="#id17" title="Permalink to this headline">#</a></h2> <p>Date: 01/30/2021</p> <div class="section" id="id19"> <h3>New in this release<a class="headerlink" href="#id19" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Bug fixes and internal refactor.</p></li> <li><p>Bump TensorFlow base package version to 1.15.5.</p></li> <li><p>Introduced a new argument <code class="docutils literal notranslate"><span class="pre">convert_constants_to_variables</span></code> to the compilation API <code class="docutils literal notranslate"><span class="pre">tfn.saved_model.compile</span></code>. Setting it to <code class="docutils literal notranslate"><span class="pre">True</span></code> can address the issue of large constants consuming too much memory in the TensorFlow runtime.</p></li> </ol> </div> </div> <div class="section" id="id20"> <span id="id21"></span><h2><a class="toc-backref" href="#id109">[1.15.4.1.1.3.0]</a><a class="headerlink" href="#id20" title="Permalink to this headline">#</a></h2> <p>Date: 12/23/2020</p> <div class="section" id="id22"> <h3>New in this release<a class="headerlink" href="#id22" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Improved logging during <cite>tfn.saved_model.compile</cite> to display <cite>neuron-cc</cite> compilation progress.</p></li> <li><p>Small performance improvement in some edge cases by optimizing the NeuronCore-executable assignment mechanism.</p></li> </ol> </div> </div> <div class="section" id="id23"> <span id="id24"></span><h2><a class="toc-backref" href="#id110">[1.15.4.1.0.2168.0]</a><a class="headerlink" href="#id23" title="Permalink to this headline">#</a></h2> <p>Date: 11/17/2020</p> <div class="section" id="id25"> <h3>New in this release<a class="headerlink" href="#id25" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>tensorflow-neuron is now a plugin package that can be used together with TensorFlow~=1.15.0 built with <code class="docutils literal notranslate"><span class="pre">GLIBCXX_USE_CXX11_ABI=0</span></code>.</p></li> <li><p>Improved logging during <code class="docutils literal notranslate"><span class="pre">tfn.saved_model.compile</span></code> to display <code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code> logging file path, which is useful for tracking <code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code> compilation progress.</p></li> <li><p>Small performance improvement by utilizing shared memory more efficiently.</p></li> </ol> </div> </div> <div class="section" id="id26"> <span id="id27"></span><h2><a class="toc-backref" href="#id111">[1.15.3.1.0.2043.0]</a><a class="headerlink" href="#id26" title="Permalink to this headline">#</a></h2> <p>Date: 09/22/2020</p> <div class="section" id="id28"> <h3>New in this release<a class="headerlink" href="#id28" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>tensorflow-neuron now automatically enables data parallel mode on four cores in one Inferentia. In <code class="docutils literal notranslate"><span class="pre">TensorFlow-model-server-neuron</span></code>, most models can now fully utilize four cores automatically. In Python TensorFlow, running threaded inference using <code class="docutils literal notranslate"><span class="pre">&gt;=4</span></code> Python threads in the same TensorFlow Session lead to full utilization of four cores.</p></li> <li><p>tensorflow-neuron now tries to enable dynamic batch size automatically for a limited number of models, such as ResNet50.</p></li> <li><p>Improved logging during <code class="docutils literal notranslate"><span class="pre">tfn.saved_model.compile</span></code> to display input/output information about subgraphs that are going to be compiled by <code class="docutils literal notranslate"><span class="pre">neuron-cc</span></code>.</p></li> </ol> </div> </div> <div class="section" id="id29"> <span id="id30"></span><h2><a class="toc-backref" href="#id112">[1.15.3.1.0.1965.0]</a><a class="headerlink" href="#id29" title="Permalink to this headline">#</a></h2> <p>Date: 08/08/2020</p> <div class="section" id="summary-1"> <span id="id31"></span><h3>New in this release<a class="headerlink" href="#summary-1" title="Permalink to this headline">#</a></h3> <p>Various minor improvements.</p> </div> </div> <div class="section" id="id32"> <span id="id33"></span><h2><a class="toc-backref" href="#id113">[1.15.3.1.0.1953.0]</a><a class="headerlink" href="#id32" title="Permalink to this headline">#</a></h2> <p>Date: 08/05/2020</p> <div class="section" id="summary-2"> <span id="id34"></span><h3>New in this release<a class="headerlink" href="#summary-2" title="Permalink to this headline">#</a></h3> <p>Various minor improvements.</p> </div> </div> <div class="section" id="id35"> <span id="id36"></span><h2><a class="toc-backref" href="#id114">[1.15.3.1.0.1891.0]</a><a class="headerlink" href="#id35" title="Permalink to this headline">#</a></h2> <p>Date: 07/16/2020</p> <div class="section" id="summary-3"> <span id="id37"></span><h3>New in this release<a class="headerlink" href="#summary-3" title="Permalink to this headline">#</a></h3> <p>This version contains a few bug fixes and user experience improvements.</p> </div> <div class="section" id="dependency-change"> <h3>Dependency change<a class="headerlink" href="#dependency-change" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Bump TensorFlow base package version number to 1.15.3</p></li> <li><p>Add <code class="docutils literal notranslate"><span class="pre">TensorFlow</span> <span class="pre">&gt;=</span> <span class="pre">1.15.0,</span> <span class="pre">&lt;</span> <span class="pre">1.16.0</span></code> as an installation dependency so that packages depending on TensorFlow can be installed together with tensorflow-neuron without error</p></li> </ol> </div> <div class="section" id="new-features"> <h3>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p><code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code> now displays a summary of model performance when profiling is enable by setting environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_PROFILE</span></code></p></li> </ol> </div> <div class="section" id="id38"> <h3>Resolved Issues<a class="headerlink" href="#id38" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_PROFILE</span></code> can now be set to a non-existing path which will be automatically created</p></li> <li><p>Fixed a bug in <code class="docutils literal notranslate"><span class="pre">tfn.saved_model.compile</span></code> that causes compilation failure when <code class="docutils literal notranslate"><span class="pre">dynamic_batch_size=True</span></code> is specified on a SavedModel with unknown rank inputs.</p></li> </ol> </div> </div> <div class="section" id="id39"> <span id="id40"></span><h2><a class="toc-backref" href="#id115">[1.15.2.1.0.1796.0]</a><a class="headerlink" href="#id39" title="Permalink to this headline">#</a></h2> <p>Date 6/11/2020</p> <div class="section" id="summary-4"> <span id="id41"></span><h3>New in this release<a class="headerlink" href="#summary-4" title="Permalink to this headline">#</a></h3> <p>This version contains a few bug fixes.</p> </div> <div class="section" id="major-new-features"> <h3>Major New Features<a class="headerlink" href="#major-new-features" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="resolved-issues-1"> <span id="id42"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-1" title="Permalink to this headline">#</a></h3> <ol class="arabic simple"> <li><p>Fixed a bug related with device placement. Now models with device information hardcoded to GPU can be successfully compiled with <code class="docutils literal notranslate"><span class="pre">tfn.saved_model.compile</span></code></p></li> <li><p>Fixed a bug in <code class="docutils literal notranslate"><span class="pre">tfn.saved_model.compile</span></code> that causes models containing Reshape operators not functioning correctly when it is compiled with <code class="docutils literal notranslate"><span class="pre">dynamic_batch_size=True</span></code></p></li> <li><p>Fixed a bug in <code class="docutils literal notranslate"><span class="pre">tfn.saved_model.compile</span></code> that causes models containing Table related operators to initialize incorrectly after compilation.</p></li> </ol> </div> <div class="section" id="known-issues-and-limitations"> <h3>Known Issues and limitations<a class="headerlink" href="#known-issues-and-limitations" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="id43"> <span id="id44"></span><h2><a class="toc-backref" href="#id116">[1.15.2.1.0.1572.0]</a><a class="headerlink" href="#id43" title="Permalink to this headline">#</a></h2> <p>Date: 5/11/2020</p> <div class="section" id="summary-5"> <span id="id45"></span><h3>New in this release<a class="headerlink" href="#summary-5" title="Permalink to this headline">#</a></h3> <p>This version contains some bug fixes and new features.</p> </div> <div class="section" id="major-new-features-1"> <span id="id46"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-1" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>tensorflow-neuron is now built on TensorFlow 1.15.2 instead of TensorFlow 1.15.0</p></li> </ul> </div> <div class="section" id="resolved-issues-2"> <span id="id47"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-2" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fixed a bug that caused Neuron runtime resources to not all be released when a tensorflow-neuron process terminated with in-flight inferences</p></li> <li><p>Inference timeout value set at compile time is now correctly recognized at runtime</p></li> </ul> </div> <div class="section" id="id48"> <h3>Known Issues and limitations<a class="headerlink" href="#id48" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="id49"> <span id="id50"></span><h2><a class="toc-backref" href="#id117">[1.15.0.1.0.1333.0]</a><a class="headerlink" href="#id49" title="Permalink to this headline">#</a></h2> <p>Date: 3/26/2020</p> <div class="section" id="summary-6"> <span id="id51"></span><h3>New in this release<a class="headerlink" href="#summary-6" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="major-new-features-2"> <span id="id52"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-2" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Improved performance between TensorFlow to Neuron runtime.</p></li> </ul> </div> <div class="section" id="resolved-issues-3"> <span id="id53"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-3" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fixed a bug in Neuron runtime adaptor operator’s shape function when dynamic batch size inference is enabled</p></li> <li><p>Framework method (tensorflow.neuron.saved-model.compile) improved handling of compiler timeout termination by letting it clean up before exiting.</p></li> </ul> </div> <div class="section" id="known-issues-and-limitations-2"> <span id="id54"></span><h3>Known Issues and limitations<a class="headerlink" href="#known-issues-and-limitations-2" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="id55"> <span id="id56"></span><h2><a class="toc-backref" href="#id118">[1.15.0.1.0.1240.0]</a><a class="headerlink" href="#id55" title="Permalink to this headline">#</a></h2> <p>Date: 2/27/2020</p> <div class="section" id="summary-7"> <span id="id57"></span><h3>New in this release<a class="headerlink" href="#summary-7" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="major-new-features-3"> <span id="id58"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-3" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Enabled runtime memory optimizations by default to improve inference performance, specifically in cases with large input/output tensors</p></li> <li><p>tfn.saved_model.compile now displays warning message instead of “successfully compiled” if less than 30% of operators are mapped to Inferentia</p></li> <li><p>Improve error messages. Runtime failure error messages are now more descriptive and also provide instructions to restart neuron-rtd when necessary.</p></li> </ul> </div> <div class="section" id="resolved-issues-4"> <span id="id59"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-4" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="known-issues-and-limitations-3"> <span id="id60"></span><h3>Known Issues and Limitations<a class="headerlink" href="#known-issues-and-limitations-3" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Issue: When compiling a large model, may encounter.</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">terminate</span> <span class="n">called</span> <span class="n">after</span> <span class="n">throwing</span> <span class="n">an</span> <span class="n">instance</span> <span class="n">of</span> <span class="s1">'std::bad_alloc'</span> </pre></div> </div> <p>Solution: run compilation on c5.4xlarge instance type or larger.</p> </div> <div class="section" id="other-notes"> <h3>Other Notes<a class="headerlink" href="#other-notes" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="id61"> <span id="id62"></span><h2><a class="toc-backref" href="#id119">[1.15.0.1.0.997.0]</a><a class="headerlink" href="#id61" title="Permalink to this headline">#</a></h2> <p>Date: 1/27/2020</p> <div class="section" id="summary-8"> <span id="id63"></span><h3>New in this release<a class="headerlink" href="#summary-8" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="major-new-features-4"> <span id="id64"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-4" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Added support for NCHW pooling operators in tfn.saved_model.compile.</p></li> </ul> </div> <div class="section" id="resolved-issues-5"> <span id="id65"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-5" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fixed GRPC transient status error issue.</p></li> <li><p>Fixed a graph partitioner issue with control inputs.</p></li> </ul> </div> <div class="section" id="known-issues-and-limitations-4"> <span id="id66"></span><h3>Known Issues and Limitations<a class="headerlink" href="#known-issues-and-limitations-4" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Issue: When compiling a large model, may encounter.</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">terminate</span> <span class="n">called</span> <span class="n">after</span> <span class="n">throwing</span> <span class="n">an</span> <span class="n">instance</span> <span class="n">of</span> <span class="s1">'std::bad_alloc'</span> </pre></div> </div> <p>Solution: run compilation on c5.4xlarge instance type or larger.</p> </div> <div class="section" id="other-notes-1"> <span id="id67"></span><h3>Other Notes<a class="headerlink" href="#other-notes-1" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="id68"> <span id="id69"></span><h2><a class="toc-backref" href="#id120">[1.15.0.1.0.803.0]</a><a class="headerlink" href="#id68" title="Permalink to this headline">#</a></h2> <p>Date: 12/20/2019</p> <div class="section" id="summary-9"> <span id="id70"></span><h3>New in this release<a class="headerlink" href="#summary-9" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="major-new-features-5"> <span id="id71"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-5" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="resolved-issues-6"> <span id="id72"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-6" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Improved handling of <code class="docutils literal notranslate"><span class="pre">tf.neuron.saved_model.compile</span></code> arguments</p></li> </ul> </div> <div class="section" id="known-issues-and-limitations-5"> <span id="id73"></span><h3>Known Issues and Limitations<a class="headerlink" href="#known-issues-and-limitations-5" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="other-notes-2"> <span id="id74"></span><h3>Other Notes<a class="headerlink" href="#other-notes-2" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="id75"> <span id="id76"></span><h2><a class="toc-backref" href="#id121">[1.15.0.1.0.749.0]</a><a class="headerlink" href="#id75" title="Permalink to this headline">#</a></h2> <p>Date: 12/1/2019</p> <div class="section" id="summary-10"> <span id="id77"></span><h3>New in this release<a class="headerlink" href="#summary-10" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="major-new-features-6"> <span id="id78"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-6" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="resolved-issues-7"> <span id="id79"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-7" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fix race condition between model load and model unload when the process is killed</p></li> <li><p>Remove unnecessary GRPC calls when the process is killed</p></li> </ul> </div> <div class="section" id="known-issues-and-limitations-6"> <span id="id80"></span><h3>Known Issues and Limitations<a class="headerlink" href="#known-issues-and-limitations-6" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>When compiling a large model, may encounter “terminate called after throwing an instance of ‘std::bad_alloc’”. Solution: run compilation on c5.4xlarge instance type or larger.</p></li> <li><p>The pip package <code class="docutils literal notranslate"><span class="pre">wrapt</span></code> may have a conflicting version in some installations. This is seen when this error occurs:</p></li> </ul> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ERROR:<span class="w"> </span>Cannot<span class="w"> </span>uninstall<span class="w"> </span><span class="s1">'wrapt'</span>.<span class="w"> </span>It<span class="w"> </span>is<span class="w"> </span>a<span class="w"> </span>distutils<span class="w"> </span>installed<span class="w"> </span>project<span class="w"> </span>and<span class="w"> </span>thus<span class="w"> </span>we<span class="w"> </span>cannot<span class="w"> </span>accurately<span class="w"> </span>determine<span class="w"> </span>which<span class="w"> </span>files<span class="w"> </span>belong<span class="w"> </span>to<span class="w"> </span>it<span class="w"> </span>which<span class="w"> </span>would<span class="w"> </span>lead<span class="w"> </span>to<span class="w"> </span>only<span class="w"> </span>a<span class="w"> </span>partial<span class="w"> </span>uninstall. </pre></div> </div> <p>To solve this, you can update wrapt to the newer version:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>wrapt<span class="w"> </span>--ignore-installed python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>tensorflow-neuron </pre></div> </div> <p>Within a Conda environment:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>update<span class="w"> </span>wrapt conda<span class="w"> </span>update<span class="w"> </span>tensorflow-neuron </pre></div> </div> </div> <div class="section" id="other-notes-3"> <span id="id81"></span><h3>Other Notes<a class="headerlink" href="#other-notes-3" title="Permalink to this headline">#</a></h3> </div> </div> <div class="section" id="id82"> <span id="id83"></span><h2><a class="toc-backref" href="#id122">[1.15.0.1.0.663.0]</a><a class="headerlink" href="#id82" title="Permalink to this headline">#</a></h2> <p>Date: 11/25/2019</p> <div class="section" id="summary-11"> <span id="id84"></span><h3>New in this release<a class="headerlink" href="#summary-11" title="Permalink to this headline">#</a></h3> <p>This version is available only in released DLAMI v26.0 and is based on TensorFlow version 1.15.0. Please <span class="xref std std-ref">update</span> to latest version.</p> </div> <div class="section" id="major-new-features-7"> <span id="id85"></span><h3>Major New Features<a class="headerlink" href="#major-new-features-7" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="resolved-issues-8"> <span id="id86"></span><h3>Resolved Issues<a class="headerlink" href="#resolved-issues-8" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="known-issues-and-limits"> <h3>Known Issues and Limits<a class="headerlink" href="#known-issues-and-limits" title="Permalink to this headline">#</a></h3> </div> <div class="section" id="models-supported"> <h3>Models Supported<a class="headerlink" href="#models-supported" title="Permalink to this headline">#</a></h3> <p>The following models have successfully run on neuron-inferentia systems</p> <ol class="arabic simple"> <li><p>BERT_LARGE and BERT_BASE</p></li> <li><p>Transformer</p></li> <li><p>Resnet50 V1/V2</p></li> <li><p>Inception-V2/V3/V4</p></li> </ol> </div> <div class="section" id="other-notes-4"> <span id="id87"></span><h3>Other Notes<a class="headerlink" href="#other-notes-4" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Python versions supported:</p> <ul> <li><p>3.5, 3.6, 3.7</p></li> </ul> </li> <li><p>Linux distribution supported:</p> <ul> <li><p>Ubuntu 18, Amazon Linux 2</p></li> </ul> </li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">Misc (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)</p> </div> </a> <a class="right-next" id="next-link" href="tensorflow-neuron-v2.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF2.x)</span></code>) Release Notes</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:20.301Z
TensorFlow Neuron (tensorflow-neuron (TF2.x)) Accelerated (torch-neuron) Python APIs and Graph Ops — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html
# TensorFlow Neuron (tensorflow-neuron (TF2.x)) Accelerated (torch-neuron) Python APIs and Graph Ops — AWS Neuron Documentation Toggle in-page Table of Contents _This document is relevant for_: `Inf1` ## TensorFlow Neuron (`tensorflow-neuron (TF2.x)`) Accelerated (torch-neuron) Python APIs and Graph Ops[#](#tensorflow-neuron-tensorflow-neuron-tf2-x-accelerated-torch-neuron-python-apis-and-graph-ops "Permalink to this headline") This page lists TensorFlow 2.x Python APIs and graph operators that are accelerated by AWS Neuron. The lists are not exhaustive. TensorFlow 2.x Python APIs or graph operators that are not listed here may still be accelerated if they are composed of accelerated primitives, or they will be executed on CPU without significant acceleration. The TensorFlow Neuron integration contains an automatic operator-device-placement mechanism that strives to maximize the execution efficiency of your deep learning models on AWS Machine Learning ASIC instances. ## Accelerated Python APIs[#](#accelerated-python-apis "Permalink to this headline") | Module | Accelerated Python API | Comments | | --- | --- | --- | | `tf` | `tf.abs` | | | | `tf.add` | | | | `tf.add_n` | | | | `tf.broadcast_static_shape` | | | | `tf.cast` | | | | `tf.constant` | | | | `tf.convert_to_tensor` | | | | `tf.cumsum` | `axis` must be a compile-time constant. | | | `tf.einsum` | | | | `tf.erf` | | | | `tf.exp` | | | | `tf.identity` | | | | `tf.matmul` | Uses float16/bfloat16 matmul with float32 accumulation. | | | `tf.maximum` | | | | `tf.minimum` | | | | `tf.multiply` | | | | `tf.negative` | | | | `tf.range` | `start`, `limit` and `delta` arguments must be compile-time constants. | | | `tf.realdiv` | | | | `tf.reciprocal` | | | | `tf.reduce_all` | `axis` must be a compile-time constant. | | | `tf.reduce_any` | `axis` must be a compile-time constant. | | | `tf.reduce_max` | `axis` must be a compile-time constant. | | | `tf.reduce_min` | `axis` must be a compile-time constant. | | | `tf.reduce_prod` | `axis` must be a compile-time constant. | | | `tf.reduce_sum` | `axis` must be a compile-time constant. | | | `tf.reshape` | `shape` argument must be a compile-time constant. | | | `tf.rsqrt` | | | | `tf.scalar_mul` | | | | `tf.shape` | | | | `tf.shape_n` | | | | `tf.sigmoid` | | | | `tf.size` | | | | `tf.slice` | `size` must be a compile-time constant. In addition, either `begin` must be a compile-time constant or `size` must be non-negative. | | | `tf.sqrt` | | | | `tf.square` | | | | `tf.squared_difference` | | | | `tf.squeeze` | | | | `tf.stack` | | | | `tf.stop_gradient` | | | | `tf.strided_slice` | | | | `tf.tanh` | | | | `tf.tensordot` | | | | `tf.to_bfloat16` | | | | `tf.to_float` | | | | `tf.truediv` | | | `tf.layers` | `tf.layers.batch_normalization` | | | | `tf.layers.dense` | | | | `tf.layers.flatten` | | | `tf.nn` | `tf.nn.batch_normalization` | | | | `tf.nn.bias_add` | | | | `tf.nn.dropout` | Always treated as `tf.identity` during inference. | | | `tf.nn.fused_batch_norm` | | | | `tf.nn.leaky_relu` | | | | `tf.nn.relu` | | | | `tf.nn.relu6` | | | | `tf.nn.relu_layer` | | | | `tf.nn.softmax` | | ## Accelerated graph operators[#](#accelerated-graph-operators "Permalink to this headline") ``` Add AddN AddV2 BatchMatMul BatchMatMulV2 BiasAdd Cast Const Cumsum Einsum Erf Exp ExpandDims FusedBatchNorm FusedBatchNormV2 FusedBatchNormV3 Greater Identity LeakyRelu MatMul Max Maximum Minimum Mean Mul Neg Pack RealDiv Relu Relu6 Reshape Rsqrt Sigmoid Softmax Split SplitV Sqrt Square SquaredDifference Squeeze StridedSlice Sub Sum Tanh Transpose Unpack ``` The lists share many commonalities with [Available TensorFlow Ops](https://cloud.google.com/tpu/docs/tensorflow-ops). Portions of this page are modifications based on work created and [shared by Google](https://developers.google.com/terms/site-policies) and used according to terms described in the [Creative Commons 4.0 Attribution License](https://creativecommons.org/licenses/by/4.0/). _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow Neuron (tensorflow-neuron (TF2.x)) Accelerated (torch-neuron) Python APIs and Graph Ops — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> <link rel="prev" title="TensorFlow Neuron (tensorflow-neuron (TF2.x)) Release Notes" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="misc-tensorflow-neuron.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#accelerated-python-apis"> Accelerated Python APIs </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#accelerated-graph-operators"> Accelerated graph operators </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow Neuron (tensorflow-neuron (TF2.x)) Accelerated (torch-neuron) Python APIs and Graph Ops</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#accelerated-python-apis"> Accelerated Python APIs </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#accelerated-graph-operators"> Accelerated graph operators </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tensorflow-neuron-tensorflow-neuron-tf2-x-accelerated-torch-neuron-python-apis-and-graph-ops"> <span id="tensorflow-ref-neuron-accelerated-ops"></span><h1>TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF2.x)</span></code>) Accelerated (torch-neuron) Python APIs and Graph Ops<a class="headerlink" href="#tensorflow-neuron-tensorflow-neuron-tf2-x-accelerated-torch-neuron-python-apis-and-graph-ops" title="Permalink to this headline">#</a></h1> <p>This page lists TensorFlow 2.x Python APIs and graph operators that are accelerated by AWS Neuron. The lists are not exhaustive. TensorFlow 2.x Python APIs or graph operators that are not listed here may still be accelerated if they are composed of accelerated primitives, or they will be executed on CPU without significant acceleration. The TensorFlow Neuron integration contains an automatic operator-device-placement mechanism that strives to maximize the execution efficiency of your deep learning models on AWS Machine Learning ASIC instances.</p> <div class="section" id="accelerated-python-apis"> <h2>Accelerated Python APIs<a class="headerlink" href="#accelerated-python-apis" title="Permalink to this headline">#</a></h2> <table class="table"> <colgroup> <col style="width: 14%"> <col style="width: 32%"> <col style="width: 54%"> </colgroup> <thead> <tr class="row-odd"><th class="head"><p>Module</p></th> <th class="head"><p>Accelerated Python API</p></th> <th class="head"><p>Comments</p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">tf</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.abs</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.add</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.add_n</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.broadcast_static_shape</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.cast</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.constant</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.convert_to_tensor</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.cumsum</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">axis</span></code> must be a compile-time constant.</p></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.einsum</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.erf</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.exp</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.identity</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.matmul</span></code></p></td> <td><p>Uses float16/bfloat16 matmul with float32 accumulation.</p></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.maximum</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.minimum</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.multiply</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.negative</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.range</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">start</span></code>, <code class="docutils literal notranslate"><span class="pre">limit</span></code> and <code class="docutils literal notranslate"><span class="pre">delta</span></code> arguments must be compile-time constants.</p></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.realdiv</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.reciprocal</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.reduce_all</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">axis</span></code> must be a compile-time constant.</p></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.reduce_any</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">axis</span></code> must be a compile-time constant.</p></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.reduce_max</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">axis</span></code> must be a compile-time constant.</p></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.reduce_min</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">axis</span></code> must be a compile-time constant.</p></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.reduce_prod</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">axis</span></code> must be a compile-time constant.</p></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.reduce_sum</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">axis</span></code> must be a compile-time constant.</p></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.reshape</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">shape</span></code> argument must be a compile-time constant.</p></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.rsqrt</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.scalar_mul</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.shape</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.shape_n</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.sigmoid</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.size</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.slice</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">size</span></code> must be a compile-time constant. In addition,</p> <p>either <code class="docutils literal notranslate"><span class="pre">begin</span></code> must be a compile-time constant or</p> <p><code class="docutils literal notranslate"><span class="pre">size</span></code> must be non-negative.</p> </td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.sqrt</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.square</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.squared_difference</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.squeeze</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.stack</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.stop_gradient</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.strided_slice</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.tanh</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.tensordot</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.to_bfloat16</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.to_float</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.truediv</span></code></p></td> <td></td> </tr> <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">tf.layers</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.layers.batch_normalization</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.layers.dense</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.layers.flatten</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">tf.nn</span></code></p></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.nn.batch_normalization</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.nn.bias_add</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.nn.dropout</span></code></p></td> <td><p>Always treated as <code class="docutils literal notranslate"><span class="pre">tf.identity</span></code> during inference.</p></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.nn.fused_batch_norm</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.nn.leaky_relu</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.nn.relu</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.nn.relu6</span></code></p></td> <td></td> </tr> <tr class="row-even"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.nn.relu_layer</span></code></p></td> <td></td> </tr> <tr class="row-odd"><td></td> <td><p><code class="docutils literal notranslate"><span class="pre">tf.nn.softmax</span></code></p></td> <td></td> </tr> </tbody> </table> </div> <div class="section" id="accelerated-graph-operators"> <h2>Accelerated graph operators<a class="headerlink" href="#accelerated-graph-operators" title="Permalink to this headline">#</a></h2> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">Add</span> <span class="n">AddN</span> <span class="n">AddV2</span> <span class="n">BatchMatMul</span> <span class="n">BatchMatMulV2</span> <span class="n">BiasAdd</span> <span class="n">Cast</span> <span class="n">Const</span> <span class="n">Cumsum</span> <span class="n">Einsum</span> <span class="n">Erf</span> <span class="n">Exp</span> <span class="n">ExpandDims</span> <span class="n">FusedBatchNorm</span> <span class="n">FusedBatchNormV2</span> <span class="n">FusedBatchNormV3</span> <span class="n">Greater</span> <span class="n">Identity</span> <span class="n">LeakyRelu</span> <span class="n">MatMul</span> <span class="n">Max</span> <span class="n">Maximum</span> <span class="n">Minimum</span> <span class="n">Mean</span> <span class="n">Mul</span> <span class="n">Neg</span> <span class="n">Pack</span> <span class="n">RealDiv</span> <span class="n">Relu</span> <span class="n">Relu6</span> <span class="n">Reshape</span> <span class="n">Rsqrt</span> <span class="n">Sigmoid</span> <span class="n">Softmax</span> <span class="n">Split</span> <span class="n">SplitV</span> <span class="n">Sqrt</span> <span class="n">Square</span> <span class="n">SquaredDifference</span> <span class="n">Squeeze</span> <span class="n">StridedSlice</span> <span class="n">Sub</span> <span class="n">Sum</span> <span class="n">Tanh</span> <span class="n">Transpose</span> <span class="n">Unpack</span> </pre></div> </div> <p>The lists share many commonalities with <a class="reference external" href="https://cloud.google.com/tpu/docs/tensorflow-ops">Available TensorFlow Ops</a>. Portions of this page are modifications based on work created and <a class="reference external" href="https://developers.google.com/terms/site-policies">shared by Google</a> and used according to terms described in the <a class="reference external" href="https://creativecommons.org/licenses/by/4.0/">Creative Commons 4.0 Attribution License</a>.</p> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF2.x)</span></code>) Release Notes</p> </div> </a> <a class="right-next" id="next-link" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF1.x)</span></code>) Supported operators</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:20.785Z
Misc (tensorflow-neuron) — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html
# Misc (tensorflow-neuron) — AWS Neuron Documentation previous TensorFlow Neuron (`tensorflow-neuron`) Auto Multicore Replication (Experimental)
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Misc (tensorflow-neuron) — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow Neuron (tensorflow-neuron (TF1.x)) Release Notes" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> <link rel="prev" title="TensorFlow Neuron (tensorflow-neuron) Auto Multicore Replication (Experimental)" href="api-auto-replication-api.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="current reference internal" href="#"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Misc (tensorflow-neuron)</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="misc-tensorflow-neuron"> <h1>Misc (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>)<a class="headerlink" href="#misc-tensorflow-neuron" title="Permalink to this headline">#</a></h1> <div class="toctree-wrapper compound"> </div> <ul class="simple"> <li><p><a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html#tensorflow-neuron-release-notes"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF1.x)) Release Notes</span></a></p></li> <li><p><a class="reference internal" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html#tensorflow-neuron-rn-v2"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF2.x)) Release Notes</span></a></p></li> <li><p><a class="reference internal" href="tensorflow2-accelerated-ops.html#tensorflow-ref-neuron-accelerated-ops"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF2.x)) Accelerated (torch-neuron) Python APIs and Graph Ops</span></a></p></li> <li><p><a class="reference internal" href="../../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html#neuron-cc-ops-tensorflow"><span class="std std-ref">TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators</span></a></p></li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="api-auto-replication-api.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) Auto Multicore Replication (Experimental)</p> </div> </a> <a class="right-next" id="next-link" href="../../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF1.x)</span></code>) Release Notes</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:21.288Z
TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html
# TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators — AWS Neuron Documentation Toggle in-page Table of Contents Contents - [Neuron Compiler Release \[1.9.1.0\]](#neuron-compiler-release-1-9-1-0) - [Neuron Compiler Release \[1.7.3.0\]](#neuron-compiler-release-1-7-3-0) - [Neuron Compiler Release \[1.6.13.0\]](#neuron-compiler-release-1-6-13-0) - [Neuron Compiler Release \[1.5.5.0\]](#neuron-compiler-release-1-5-5-0) - [Neuron Compiler Release \[1.4.0.0\]](#neuron-compiler-release-1-4-0-0) - [Neuron Compiler Release \[1.3.0.0\]](#neuron-compiler-release-1-3-0-0) - [Neuron Compiler Release \[1.2.7.0\]](#neuron-compiler-release-1-2-7-0) - [Neuron Compiler Release \[1.2.2.0\]](#neuron-compiler-release-1-2-2-0) - [Neuron Compiler Release \[1.0.24045.0\]](#neuron-compiler-release-1-0-24045-0) - [Neuron Compiler Release \[1.0.18001\]](#neuron-compiler-release-1-0-18001) - [Neuron Compiler Release \[1.0.16764\]](#neuron-compiler-release-1-0-16764) - [Neuron Compiler Release \[1.0.15275\]](#neuron-compiler-release-1-0-15275) - [Neuron Compiler Release \[1.0.12696\]](#neuron-compiler-release-1-0-12696) - [Neuron Compiler Release \[1.0.9410\]](#neuron-compiler-release-1-0-9410) - [Neuron Compiler Release \[1.0.7878\]](#neuron-compiler-release-1-0-7878) - [Neuron Compiler Release \[1.0.6801\]](#neuron-compiler-release-1-0-6801) - [Neuron Compiler Release \[1.0.5939\]](#neuron-compiler-release-1-0-5939) - [Neuron Compiler Release \[1.0.5301\]](#neuron-compiler-release-1-0-5301) - [Neuron Compiler Release \[1.0.4680.0\]](#neuron-compiler-release-1-0-4680-0) ## Contents - [Neuron Compiler Release \[1.9.1.0\]](#neuron-compiler-release-1-9-1-0) - [Neuron Compiler Release \[1.7.3.0\]](#neuron-compiler-release-1-7-3-0) - [Neuron Compiler Release \[1.6.13.0\]](#neuron-compiler-release-1-6-13-0) - [Neuron Compiler Release \[1.5.5.0\]](#neuron-compiler-release-1-5-5-0) - [Neuron Compiler Release \[1.4.0.0\]](#neuron-compiler-release-1-4-0-0) - [Neuron Compiler Release \[1.3.0.0\]](#neuron-compiler-release-1-3-0-0) - [Neuron Compiler Release \[1.2.7.0\]](#neuron-compiler-release-1-2-7-0) - [Neuron Compiler Release \[1.2.2.0\]](#neuron-compiler-release-1-2-2-0) - [Neuron Compiler Release \[1.0.24045.0\]](#neuron-compiler-release-1-0-24045-0) - [Neuron Compiler Release \[1.0.18001\]](#neuron-compiler-release-1-0-18001) - [Neuron Compiler Release \[1.0.16764\]](#neuron-compiler-release-1-0-16764) - [Neuron Compiler Release \[1.0.15275\]](#neuron-compiler-release-1-0-15275) - [Neuron Compiler Release \[1.0.12696\]](#neuron-compiler-release-1-0-12696) - [Neuron Compiler Release \[1.0.9410\]](#neuron-compiler-release-1-0-9410) - [Neuron Compiler Release \[1.0.7878\]](#neuron-compiler-release-1-0-7878) - [Neuron Compiler Release \[1.0.6801\]](#neuron-compiler-release-1-0-6801) - [Neuron Compiler Release \[1.0.5939\]](#neuron-compiler-release-1-0-5939) - [Neuron Compiler Release \[1.0.5301\]](#neuron-compiler-release-1-0-5301) - [Neuron Compiler Release \[1.0.4680.0\]](#neuron-compiler-release-1-0-4680-0) _This document is relevant for_: `Inf1` ## TensorFlow Neuron (`tensorflow-neuron (TF1.x)`) Supported operators[#](#tensorflow-neuron-tensorflow-neuron-tf1-x-supported-operators "Permalink to this headline") To see a list of supported operators for TensorFlow 1.x, run the following command: `neuron-cc list-operators --framework TENSORFLOW` ## Neuron Compiler Release \[1.9.1.0\][#](#neuron-compiler-release-1-9-1-0 "Permalink to this headline") Date: 01/20/2022 Added ## Neuron Compiler Release \[1.7.3.0\][#](#neuron-compiler-release-1-7-3-0 "Permalink to this headline") Added ## Neuron Compiler Release \[1.6.13.0\][#](#neuron-compiler-release-1-6-13-0 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.5.5.0\][#](#neuron-compiler-release-1-5-5-0 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.4.0.0\][#](#neuron-compiler-release-1-4-0-0 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.3.0.0\][#](#neuron-compiler-release-1-3-0-0 "Permalink to this headline") Added ``` Abs Cos DepthwiseConv2dNative Erf Rank Sin Size ``` ## Neuron Compiler Release \[1.2.7.0\][#](#neuron-compiler-release-1-2-7-0 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.2.2.0\][#](#neuron-compiler-release-1-2-2-0 "Permalink to this headline") Added ``` AdjustContrastv2 AdjustSaturation BroadcastTo Cholesky Conv2DBackpropInput Conv3D CropAndResize FloorDiv HSVToRGB InvertPermutation L2Loss Log1p MatrixBandPart MatrixDiag MatrixSetDiag MatrixTriangularSolve MaxPool3D MirrorPad RGBToHSV Range SoftmaxCrossEntropyWithLogits SquaredDifference StopGradient Unpack UnsortedSegmentSum ``` ## Neuron Compiler Release \[1.0.24045.0\][#](#neuron-compiler-release-1-0-24045-0 "Permalink to this headline") Added `FloorDiv`, `Softplus`, `Unstack` ## Neuron Compiler Release \[1.0.18001\][#](#neuron-compiler-release-1-0-18001 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.0.16764\][#](#neuron-compiler-release-1-0-16764 "Permalink to this headline") Added: ``` LogSoftmax Neg ResizeBilinear ResizeNearestNeighbor ``` ## Neuron Compiler Release \[1.0.15275\][#](#neuron-compiler-release-1-0-15275 "Permalink to this headline") Added Removed (was inadvertently advertised as supported) ## Neuron Compiler Release \[1.0.12696\][#](#neuron-compiler-release-1-0-12696 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.0.9410\][#](#neuron-compiler-release-1-0-9410 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.0.7878\][#](#neuron-compiler-release-1-0-7878 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.0.6801\][#](#neuron-compiler-release-1-0-6801 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.0.5939\][#](#neuron-compiler-release-1-0-5939 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.0.5301\][#](#neuron-compiler-release-1-0-5301 "Permalink to this headline") No changes ## Neuron Compiler Release \[1.0.4680.0\][#](#neuron-compiler-release-1-0-4680-0 "Permalink to this headline") ``` Add AddV2 All AvgPool BatchMatMul BatchMatMulV2 BatchToSpaceND BiasAdd Cast Ceil Concat ConcatV2 Const Conv2D Equal Exp ExpandDims Fill Floor FusedBatchNorm Greater GreaterEqual Identity LRN LeakyRelu Less LessEqual Log LogicalAnd LogicalNot LogicalOr MatMul Max MaxPool Maximum Mean Min Minimum Mul NoOp NotEqual Pack Pad PadV2 Placeholder Pow Prod RandomUniform RealDiv Reciprocal Relu Relu6 Reshape ReverseV2 Round Rsqrt Select Shape Sigmoid Sign Slice Softmax SpaceToBatchND Split SplitV Sqrt Square Squeeze StridedSlice Sub Sum Tanh Tile Transpose ZerosLike ``` _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css"> <link rel="stylesheet" href="../../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> <script src="../../../../_static/jquery.js"></script> <script src="../../../../_static/underscore.js"></script> <script src="../../../../_static/doctools.js"></script> <script src="../../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../../_static/contentui.js"></script> <script src="../../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../../genindex.html"> <link rel="search" title="Search" href="../../../../search.html"> <link rel="next" title="Training" href="../../../../frameworks/tensorflow/training.html"> <link rel="prev" title="TensorFlow Neuron (tensorflow-neuron (TF2.x)) Accelerated (torch-neuron) Python APIs and Graph Ops" href="../../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../../compiler/index.html"> Neuron Compiler </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="../../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../neuron-cc.html"> What's New </a> </li> <li class="toctree-l4 current active"> <a class="reference internal" href="index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Frelease-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../../_sources/release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-9-1-0"> Neuron Compiler Release [1.9.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-7-3-0"> Neuron Compiler Release [1.7.3.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-6-13-0"> Neuron Compiler Release [1.6.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-5-5-0"> Neuron Compiler Release [1.5.5.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-4-0-0"> Neuron Compiler Release [1.4.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-3-0-0"> Neuron Compiler Release [1.3.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-2-7-0"> Neuron Compiler Release [1.2.7.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-2-2-0"> Neuron Compiler Release [1.2.2.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-24045-0"> Neuron Compiler Release [1.0.24045.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-18001"> Neuron Compiler Release [1.0.18001] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-16764"> Neuron Compiler Release [1.0.16764] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-15275"> Neuron Compiler Release [1.0.15275] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-12696"> Neuron Compiler Release [1.0.12696] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-9410"> Neuron Compiler Release [1.0.9410] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-7878"> Neuron Compiler Release [1.0.7878] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-6801"> Neuron Compiler Release [1.0.6801] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-5939"> Neuron Compiler Release [1.0.5939] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-5301"> Neuron Compiler Release [1.0.5301] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-4680-0"> Neuron Compiler Release [1.0.4680.0] </a> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-9-1-0"> Neuron Compiler Release [1.9.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-7-3-0"> Neuron Compiler Release [1.7.3.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-6-13-0"> Neuron Compiler Release [1.6.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-5-5-0"> Neuron Compiler Release [1.5.5.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-4-0-0"> Neuron Compiler Release [1.4.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-3-0-0"> Neuron Compiler Release [1.3.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-2-7-0"> Neuron Compiler Release [1.2.7.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-2-2-0"> Neuron Compiler Release [1.2.2.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-24045-0"> Neuron Compiler Release [1.0.24045.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-18001"> Neuron Compiler Release [1.0.18001] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-16764"> Neuron Compiler Release [1.0.16764] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-15275"> Neuron Compiler Release [1.0.15275] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-12696"> Neuron Compiler Release [1.0.12696] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-9410"> Neuron Compiler Release [1.0.9410] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-7878"> Neuron Compiler Release [1.0.7878] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-6801"> Neuron Compiler Release [1.0.6801] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-5939"> Neuron Compiler Release [1.0.5939] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-5301"> Neuron Compiler Release [1.0.5301] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#neuron-compiler-release-1-0-4680-0"> Neuron Compiler Release [1.0.4680.0] </a> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tensorflow-neuron-tensorflow-neuron-tf1-x-supported-operators"> <span id="neuron-cc-ops-tensorflow"></span><h1>TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF1.x)</span></code>) Supported operators<a class="headerlink" href="#tensorflow-neuron-tensorflow-neuron-tf1-x-supported-operators" title="Permalink to this headline">#</a></h1> <p>To see a list of supported operators for TensorFlow 1.x, run the following command:</p> <p><code class="docutils literal notranslate"><span class="pre">neuron-cc</span> <span class="pre">list-operators</span> <span class="pre">--framework</span> <span class="pre">TENSORFLOW</span></code></p> <div class="section" id="neuron-compiler-release-1-9-1-0"> <span id="neuron-compiler-release-1910"></span><h2>Neuron Compiler Release [1.9.1.0]<a class="headerlink" href="#neuron-compiler-release-1-9-1-0" title="Permalink to this headline">#</a></h2> <p>Date: 01/20/2022</p> <p>Added</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">isNan</span> <span class="n">FusedBatchNormV3</span> </pre></div> </div> </div> <div class="section" id="neuron-compiler-release-1-7-3-0"> <span id="neuron-compiler-release-1730"></span><h2>Neuron Compiler Release [1.7.3.0]<a class="headerlink" href="#neuron-compiler-release-1-7-3-0" title="Permalink to this headline">#</a></h2> <p>Added</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ArgMax</span> <span class="n">ArgMin</span> </pre></div> </div> </div> <div class="section" id="neuron-compiler-release-1-6-13-0"> <span id="neuron-compiler-release-16130"></span><h2>Neuron Compiler Release [1.6.13.0]<a class="headerlink" href="#neuron-compiler-release-1-6-13-0" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-5-5-0"> <span id="neuron-compiler-release-1550"></span><h2>Neuron Compiler Release [1.5.5.0]<a class="headerlink" href="#neuron-compiler-release-1-5-5-0" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-4-0-0"> <span id="neuron-compiler-release-1400"></span><h2>Neuron Compiler Release [1.4.0.0]<a class="headerlink" href="#neuron-compiler-release-1-4-0-0" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-3-0-0"> <span id="neuron-compiler-release-1300"></span><h2>Neuron Compiler Release [1.3.0.0]<a class="headerlink" href="#neuron-compiler-release-1-3-0-0" title="Permalink to this headline">#</a></h2> <p>Added</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Abs</span> <span class="n">Cos</span> <span class="n">DepthwiseConv2dNative</span> <span class="n">Erf</span> <span class="n">Rank</span> <span class="n">Sin</span> <span class="n">Size</span> </pre></div> </div> </div> <div class="section" id="neuron-compiler-release-1-2-7-0"> <span id="neuron-compiler-release-1270"></span><h2>Neuron Compiler Release [1.2.7.0]<a class="headerlink" href="#neuron-compiler-release-1-2-7-0" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-2-2-0"> <span id="neuron-compiler-release-1220"></span><h2>Neuron Compiler Release [1.2.2.0]<a class="headerlink" href="#neuron-compiler-release-1-2-2-0" title="Permalink to this headline">#</a></h2> <p>Added</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">AdjustContrastv2</span> <span class="n">AdjustSaturation</span> <span class="n">BroadcastTo</span> <span class="n">Cholesky</span> <span class="n">Conv2DBackpropInput</span> <span class="n">Conv3D</span> <span class="n">CropAndResize</span> <span class="n">FloorDiv</span> <span class="n">HSVToRGB</span> <span class="n">InvertPermutation</span> <span class="n">L2Loss</span> <span class="n">Log1p</span> <span class="n">MatrixBandPart</span> <span class="n">MatrixDiag</span> <span class="n">MatrixSetDiag</span> <span class="n">MatrixTriangularSolve</span> <span class="n">MaxPool3D</span> <span class="n">MirrorPad</span> <span class="n">RGBToHSV</span> <span class="n">Range</span> <span class="n">SoftmaxCrossEntropyWithLogits</span> <span class="n">SquaredDifference</span> <span class="n">StopGradient</span> <span class="n">Unpack</span> <span class="n">UnsortedSegmentSum</span> </pre></div> </div> </div> <div class="section" id="neuron-compiler-release-1-0-24045-0"> <span id="neuron-compiler-release-10240450"></span><h2>Neuron Compiler Release [1.0.24045.0]<a class="headerlink" href="#neuron-compiler-release-1-0-24045-0" title="Permalink to this headline">#</a></h2> <p>Added <code class="docutils literal notranslate"><span class="pre">FloorDiv</span></code>, <code class="docutils literal notranslate"><span class="pre">Softplus</span></code>, <code class="docutils literal notranslate"><span class="pre">Unstack</span></code></p> </div> <div class="section" id="neuron-compiler-release-1-0-18001"> <span id="neuron-compiler-release-1018001"></span><h2>Neuron Compiler Release [1.0.18001]<a class="headerlink" href="#neuron-compiler-release-1-0-18001" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-0-16764"> <span id="neuron-compiler-release-1016764"></span><h2>Neuron Compiler Release [1.0.16764]<a class="headerlink" href="#neuron-compiler-release-1-0-16764" title="Permalink to this headline">#</a></h2> <p>Added:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">LogSoftmax</span> <span class="n">Neg</span> <span class="n">ResizeBilinear</span> <span class="n">ResizeNearestNeighbor</span> </pre></div> </div> </div> <div class="section" id="neuron-compiler-release-1-0-15275"> <span id="neuron-compiler-release-1015275"></span><h2>Neuron Compiler Release [1.0.15275]<a class="headerlink" href="#neuron-compiler-release-1-0-15275" title="Permalink to this headline">#</a></h2> <p>Added</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Neg</span> </pre></div> </div> <p>Removed</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Log</span> </pre></div> </div> <p>(was inadvertently advertised as supported)</p> </div> <div class="section" id="neuron-compiler-release-1-0-12696"> <span id="neuron-compiler-release-1012696"></span><h2>Neuron Compiler Release [1.0.12696]<a class="headerlink" href="#neuron-compiler-release-1-0-12696" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-0-9410"> <span id="neuron-compiler-release-109410"></span><h2>Neuron Compiler Release [1.0.9410]<a class="headerlink" href="#neuron-compiler-release-1-0-9410" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-0-7878"> <span id="neuron-compiler-release-107878"></span><h2>Neuron Compiler Release [1.0.7878]<a class="headerlink" href="#neuron-compiler-release-1-0-7878" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-0-6801"> <span id="neuron-compiler-release-106801"></span><h2>Neuron Compiler Release [1.0.6801]<a class="headerlink" href="#neuron-compiler-release-1-0-6801" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-0-5939"> <span id="neuron-compiler-release-105939"></span><h2>Neuron Compiler Release [1.0.5939]<a class="headerlink" href="#neuron-compiler-release-1-0-5939" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-0-5301"> <span id="neuron-compiler-release-105301"></span><h2>Neuron Compiler Release [1.0.5301]<a class="headerlink" href="#neuron-compiler-release-1-0-5301" title="Permalink to this headline">#</a></h2> <p>No changes</p> </div> <div class="section" id="neuron-compiler-release-1-0-4680-0"> <span id="neuron-compiler-release-1046800"></span><h2>Neuron Compiler Release [1.0.4680.0]<a class="headerlink" href="#neuron-compiler-release-1-0-4680-0" title="Permalink to this headline">#</a></h2> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Add</span> <span class="n">AddV2</span> <span class="n">All</span> <span class="n">AvgPool</span> <span class="n">BatchMatMul</span> <span class="n">BatchMatMulV2</span> <span class="n">BatchToSpaceND</span> <span class="n">BiasAdd</span> <span class="n">Cast</span> <span class="n">Ceil</span> <span class="n">Concat</span> <span class="n">ConcatV2</span> <span class="n">Const</span> <span class="n">Conv2D</span> <span class="n">Equal</span> <span class="n">Exp</span> <span class="n">ExpandDims</span> <span class="n">Fill</span> <span class="n">Floor</span> <span class="n">FusedBatchNorm</span> <span class="n">Greater</span> <span class="n">GreaterEqual</span> <span class="n">Identity</span> <span class="n">LRN</span> <span class="n">LeakyRelu</span> <span class="n">Less</span> <span class="n">LessEqual</span> <span class="n">Log</span> <span class="n">LogicalAnd</span> <span class="n">LogicalNot</span> <span class="n">LogicalOr</span> <span class="n">MatMul</span> <span class="n">Max</span> <span class="n">MaxPool</span> <span class="n">Maximum</span> <span class="n">Mean</span> <span class="n">Min</span> <span class="n">Minimum</span> <span class="n">Mul</span> <span class="n">NoOp</span> <span class="n">NotEqual</span> <span class="n">Pack</span> <span class="n">Pad</span> <span class="n">PadV2</span> <span class="n">Placeholder</span> <span class="n">Pow</span> <span class="n">Prod</span> <span class="n">RandomUniform</span> <span class="n">RealDiv</span> <span class="n">Reciprocal</span> <span class="n">Relu</span> <span class="n">Relu6</span> <span class="n">Reshape</span> <span class="n">ReverseV2</span> <span class="n">Round</span> <span class="n">Rsqrt</span> <span class="n">Select</span> <span class="n">Shape</span> <span class="n">Sigmoid</span> <span class="n">Sign</span> <span class="n">Slice</span> <span class="n">Softmax</span> <span class="n">SpaceToBatchND</span> <span class="n">Split</span> <span class="n">SplitV</span> <span class="n">Sqrt</span> <span class="n">Square</span> <span class="n">Squeeze</span> <span class="n">StridedSlice</span> <span class="n">Sub</span> <span class="n">Sum</span> <span class="n">Tanh</span> <span class="n">Tile</span> <span class="n">Transpose</span> <span class="n">ZerosLike</span> </pre></div> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF2.x)</span></code>) Accelerated (torch-neuron) Python APIs and Graph Ops</p> </div> </a> <a class="right-next" id="next-link" href="../../../../frameworks/tensorflow/training.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Training</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:21.473Z
TensorFlow Neuron (tensorflow-neuron (TF2.x)) Release Notes — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html
# TensorFlow Neuron (tensorflow-neuron (TF2.x)) Release Notes — AWS Neuron Documentation _This document is relevant for_: `Inf1` ## TensorFlow Neuron (`tensorflow-neuron (TF2.x)`) Release Notes[#](#tensorflow-neuron-tensorflow-neuron-tf2-x-release-notes "Permalink to this headline") Table of contents - [Known Issues and Limitations - updated 08/12/2021](#known-issues-and-limitations-updated-08-12-2021) - [tensorflow-neuron 2.x release \[2.10.1.0\]](#tensorflow-neuron-2-x-release-2-10-1-0) - [tensorflow-neuron 2.x release \[2.9.3.0\]](#tensorflow-neuron-2-x-release-2-9-3-0) - [tensorflow-neuron 2.x release \[2.8.9.0\]](#tensorflow-neuron-2-x-release-2-8-9-0) - [tensorflow-neuron 2.x release \[2.8.1.0\]](#tensorflow-neuron-2-x-release-2-8-1-0) - [tensorflow-neuron 2.x release \[2.7.4.0\]](#tensorflow-neuron-2-x-release-2-7-4-0) - [tensorflow-neuron 2.x release \[2.7.3.0\]](#tensorflow-neuron-2-x-release-2-7-3-0) - [tensorflow-neuron 2.x release \[2.6.5.0\]](#tensorflow-neuron-2-x-release-2-6-5-0) - [tensorflow-neuron 2.x release \[2.6.0.0\]](#tensorflow-neuron-2-x-release-2-6-0-0) - [tensorflow-neuron 2.x release \[2.4.0.0\]](#tensorflow-neuron-2-x-release-2-4-0-0) - [tensorflow-neuron 2.x release \[2.3.0.0\]](#tensorflow-neuron-2-x-release-2-3-0-0) - [tensorflow-neuron 2.x release \[2.2.0.0\]](#tensorflow-neuron-2-x-release-2-2-0-0) - [tensorflow-neuron 2.x release \[2.1.14.0\]](#tensorflow-neuron-2-x-release-2-1-14-0) - [tensorflow-neuron 2.x release \[2.1.13.0\]](#tensorflow-neuron-2-x-release-2-1-13-0) - [tensorflow-neuron 2.x release \[2.1.6.0\]](#tensorflow-neuron-2-x-release-2-1-6-0) - [tensorflow-neuron 2.x release \[2.0.4.0\]](#tensorflow-neuron-2-x-release-2-0-4-0) - [tensorflow-neuron 2.x release \[2.0.3.0\]](#tensorflow-neuron-2-x-release-2-0-3-0) - [tensorflow-neuron 2.x release \[1.6.8.0\]](#tensorflow-neuron-2-x-release-1-6-8-0) This document lists the release notes for the tensorflow-neuron 2.x packages. ## [Known Issues and Limitations - updated 08/12/2021](#id3)[#](#known-issues-and-limitations-updated-08-12-2021 "Permalink to this headline") - Support on serialized TensorFlow 2.x custom operators is currently limited. Serializing some operators registered from tensorflow-text through [TensorFlow Hub](https://tfhub.dev/) is going to cause failure in tensorflow.neuron.trace. - Memory leak exists on latest releases of TensorFlow Neuron for versions 2.1, 2.2, 2.3, and 2.4. - Issue: When compiling large models, user might run out of memory and encounter this fatal error. ``` terminate called after throwing an instance of 'std::bad_alloc' ``` Solution: run compilation on a c5.4xlarge instance type or larger. - Issue: When upgrading `tensorflow-neuron` with `pip install tensorflow-neuron --upgrade`, the following error message may appear, which is caused by `pip` version being too low. ``` Could not find a version that satisfies the requirement tensorflow<1.16.0,>=1.15.0 (from tensorflow-neuron) ``` Solution: run a `pip install pip --upgrade` before upgrading `tensorflow-neuron`. - Issue: Some Keras routines throws the following error: ``` AttributeError: 'str' object has no attribute 'decode'. ``` Solution: Please downgrade h5py by pip install ‘h5py<3’. This is caused by [https://github.com/TensorFlow/TensorFlow/issues/44467](https://github.com/TensorFlow/TensorFlow/issues/44467). ## [tensorflow-neuron 2.x release \[2.10.1.0\]](#id4)[#](#tensorflow-neuron-2-x-release-2-10-1-0 "Permalink to this headline") Date: 09/15/2023 - Minor updates. ## [tensorflow-neuron 2.x release \[2.9.3.0\]](#id5)[#](#tensorflow-neuron-2-x-release-2-9-3-0 "Permalink to this headline") Date: 7/19/2023 - Minor updates. ## [tensorflow-neuron 2.x release \[2.8.9.0\]](#id6)[#](#tensorflow-neuron-2-x-release-2-8-9-0 "Permalink to this headline") Date: 6/14/2023 - Added Python 3.10 support. ## [tensorflow-neuron 2.x release \[2.8.1.0\]](#id7)[#](#tensorflow-neuron-2-x-release-2-8-1-0 "Permalink to this headline") Date: 05/01/2023 - Added support for tracing models larger than 2 GB through the environment variable `NEURON_CC_FLAGS='--extract-weights INSTANCE_TYPE'` for all inf1 instance types. - Neuron release 2.10 release will be the last release that will include support for tensorflow-neuron version 2.7. Future Neuron releases will not include tensorflow-neuron version 2.7. ## [tensorflow-neuron 2.x release \[2.7.4.0\]](#id8)[#](#tensorflow-neuron-2-x-release-2-7-4-0 "Permalink to this headline") Date: 04/19/2023 - Minor updates. ## [tensorflow-neuron 2.x release \[2.7.3.0\]](#id9)[#](#tensorflow-neuron-2-x-release-2-7-3-0 "Permalink to this headline") Date: 03/28/2023 - Introduce the `tfn.analyze_model` function that displays information about the supported and unsupported operators of a traceable model. - Introduce the `on_neuron_ratio` attribute of AWS Optimized Neuron Models returned by `tfn.trace`, which is the percentage of ops on neuron after compilation. ## [tensorflow-neuron 2.x release \[2.6.5.0\]](#id10)[#](#tensorflow-neuron-2-x-release-2-6-5-0 "Permalink to this headline") Date: 02/24/2023 - Minor updates. ## [tensorflow-neuron 2.x release \[2.6.0.0\]](#id11)[#](#tensorflow-neuron-2-x-release-2-6-0-0 "Permalink to this headline") Date: 2/24/2023 - Minor bug fixes. ## [tensorflow-neuron 2.x release \[2.4.0.0\]](#id12)[#](#tensorflow-neuron-2-x-release-2-4-0-0 "Permalink to this headline") Date: 11/22/2022 - Experimental support for tracing models larger than 2 GB through environment variable `NEURON_CC_FLAGS='--extract-weights'`. - Introduce `tfn.auto_multicore` Python API to enable automatic data parallel on multiple NeuronCores. - Introduce `tf-neuron-auto-multicore` tool to enable automatic data parallel on multiple NeuronCores. - Deprecated the NEURONCORE\_GROUP\_SIZES environment variable. - Minor bug fixes. ## [tensorflow-neuron 2.x release \[2.3.0.0\]](#id13)[#](#tensorflow-neuron-2-x-release-2-3-0-0 "Permalink to this headline") Date: 04/29/2022 - Added support for Tensorflow 2.8.0. - Added support for Slice operator - The graph partitioner now prefers to place less compute intensive operators on CPU if the model already contains a large amount of compute intensive operators. - Fixed [Github issue #408](https://github.com/aws/aws-neuron-sdk/issues/408), the fix solves data type handling bug in `tfn.trace` when the model contains Conv2D operators. ## [tensorflow-neuron 2.x release \[2.2.0.0\]](#id14)[#](#tensorflow-neuron-2-x-release-2-2-0-0 "Permalink to this headline") Date: 03/25/2022 - Updated TensorFlow 2.5 to version 2.5.3. - Added support for TensorFlow 2.6 and 2.7. - Added a warning message when calling `tfn.saved_model.compile` API. In tensorflow-neuron 2.x you should call [tensorflow.neuron.trace](../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html#tensorflow-ref-neuron-tracing-api). `tfn.saved_model.compile` API supports only partial functionality of [tensorflow.neuron.trace](../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html#tensorflow-ref-neuron-tracing-api) and will be deprecated in the future. ## [tensorflow-neuron 2.x release \[2.1.14.0\]](#id15)[#](#tensorflow-neuron-2-x-release-2-1-14-0 "Permalink to this headline") Date: 02/17/2022 - Fixed a bug in TensorFlow Neuron versions 2.1, 2.2. 2.3 and 2.4. The fixed bug was causing a memory leak of 128 bytes for each inference. - Improved warning message when calling deprecated compilation API under tensorflow-neuron 2.x. ## [tensorflow-neuron 2.x release \[2.1.13.0\]](#id16)[#](#tensorflow-neuron-2-x-release-2-1-13-0 "Permalink to this headline") Date: 02/16/2022 - Fixed a bug that caused a memory leak. The memory leak was approximately 128b for each inference and exists in all versions of TensorFlow Neuron versions part of Neuron 1.16.0 to Neuron 1.17.0 releases. see [Previous Releases Artifacts (Neuron 2.x)](../../prev/content.html#pre-release-content) for exact versions included in each release. This release only addresses the leak in TensorFlow Neuron 2.5. Future release of TensorFlow Neuron will fix the leak in other versions as well (2.1, 2.2, 2.3, 2.4). ## [tensorflow-neuron 2.x release \[2.1.6.0\]](#id17)[#](#tensorflow-neuron-2-x-release-2-1-6-0 "Permalink to this headline") Date: 01/20/2022 - Updated TensorFlow 2.5 to version 2.5.2. - Enhanced auto data parallel (e.g. when using NEURONCORE\_GROUP\_SIZES=X,Y,Z,W) to support edge cases. - Fixed a bug that may cause tensorflow-neuron to generate in some cases scalar gather instruction with incorrect arguments. ## [tensorflow-neuron 2.x release \[2.0.4.0\]](#id18)[#](#tensorflow-neuron-2-x-release-2-0-4-0 "Permalink to this headline") Date: 11/05/2021 - Updated Neuron Runtime (which is integrated within this package) to `libnrt 2.2.18.0` to fix a container issue that was preventing the use of containers when /dev/neuron0 was not present. See details here neuron-runtime-release-notes. ## [tensorflow-neuron 2.x release \[2.0.3.0\]](#id19)[#](#tensorflow-neuron-2-x-release-2-0-3-0 "Permalink to this headline") Date: 10/27/2021 ### New in this release[#](#new-in-this-release "Permalink to this headline") - TensorFlow 2.x (`tensorflow-neuron`) now support Neuron Runtime 2.x (`libnrt.so` shared library) only. > Important > > - You must update to the latest Neuron Driver (`aws-neuron-dkms` version 2.1 or newer) for proper functionality of the new runtime library. > > - Read [Introducing Neuron Runtime 2.x (libnrt.so)](../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt) application note that describes [why are we making this change](../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-why) and how [this change will affect the Neuron SDK](../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-how-sdk) in detail. > > - Read [Migrate your application to Neuron Runtime 2.x (libnrt.so)](../../../general/appnotes/neuron1x/introducing-libnrt.html#neuron-migrating-apps-neuron-to-libnrt) for detailed information of how to migrate your application. > - Updated TensorFlow 2.3.x from TensorFlow 2.3.3 to TensorFlow 2.3.4. - Updated TensorFlow 2.4.x from TensorFlow 2.4.2 to TensorFlow 2.4.3. - Updated TensorFlow 2.5.x from TensorFlow 2.5.0 to TensorFlow 2.5.1. ### Resolved Issues[#](#resolved-issues "Permalink to this headline") - Fix bug that can cause illegal compiler optimizations - Fix bug that can cause dynamic-shape operators be placed on Neuron ## [tensorflow-neuron 2.x release \[1.6.8.0\]](#id20)[#](#tensorflow-neuron-2-x-release-1-6-8-0 "Permalink to this headline") Date: 08/12/2021 ### New in this release[#](#id2 "Permalink to this headline") - First release of TensorFlow 2.x integration, Neuron support now TensorFlow versions 2.1.4, 2.2.3, 2.3.3, 2.4.2, and 2.5.0. - New public API tensorflow.neuron.trace: trace a TensorFlow 2.x keras.Model or a Python callable that can be decorated by tf.function, and return an AWS-Neuron-optimized keras.Model that can execute on AWS Machine Learning Accelerators. > **Please note** that TensorFlow 1.x SavedModel compilation API tensorflow.neuron.saved\_model.compile is not supported in tensorflow-neuron 2.x . It continues to function in tensorflow-neuron 1.15.x . - Included versions: > - tensorflow-neuron-2.5.0.1.6.8.0 > > - tensorflow-neuron-2.4.2.1.6.8.0 > > - tensorflow-neuron-2.3.3.1.6.8.0 > > - tensorflow-neuron-2.2.3.1.6.8.0 > > - tensorflow-neuron-2.1.4.1.6.8.0 > _This document is relevant for_: `Inf1`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>TensorFlow Neuron (tensorflow-neuron (TF2.x)) Release Notes — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css"> <link rel="stylesheet" href="../../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> <script src="../../../_static/jquery.js"></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../../_static/contentui.js"></script> <script src="../../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../../genindex.html"> <link rel="search" title="Search" href="../../../search.html"> <link rel="next" title="TensorFlow Neuron (tensorflow-neuron (TF2.x)) Accelerated (torch-neuron) Python APIs and Graph Ops" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> <link rel="prev" title="TensorFlow Neuron (tensorflow-neuron (TF1.x)) Release Notes" href="tensorflow-neuron.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 current active has-children"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4 current active"> <a class="current reference internal" href="#"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/tensorflow/training.html"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../frameworks/mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Frelease-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../../_sources/release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> <label for="__page-toc" class="headerbtn headerbtn-page-toc"> <span class="headerbtn__icon-container"> <i class="fas fa-list"></i> </span> </label> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> <div class="tocsection onthispage pt-5 pb-3"> <i class="fas fa-list"></i> Contents </div> <nav id="bd-toc-nav" aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-updated-08-12-2021"> Known Issues and Limitations - updated 08/12/2021 </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-10-1-0"> tensorflow-neuron 2.x release [2.10.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-9-3-0"> tensorflow-neuron 2.x release [2.9.3.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-8-9-0"> tensorflow-neuron 2.x release [2.8.9.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-8-1-0"> tensorflow-neuron 2.x release [2.8.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-7-4-0"> tensorflow-neuron 2.x release [2.7.4.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-7-3-0"> tensorflow-neuron 2.x release [2.7.3.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-6-5-0"> tensorflow-neuron 2.x release [2.6.5.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-6-0-0"> tensorflow-neuron 2.x release [2.6.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-4-0-0"> tensorflow-neuron 2.x release [2.4.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-3-0-0"> tensorflow-neuron 2.x release [2.3.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-2-0-0"> tensorflow-neuron 2.x release [2.2.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-1-14-0"> tensorflow-neuron 2.x release [2.1.14.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-1-13-0"> tensorflow-neuron 2.x release [2.1.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-1-6-0"> tensorflow-neuron 2.x release [2.1.6.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-0-4-0"> tensorflow-neuron 2.x release [2.0.4.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-0-3-0"> tensorflow-neuron 2.x release [2.0.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#new-in-this-release"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-1-6-8-0"> tensorflow-neuron 2.x release [1.6.8.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> New in this release </a> </li> </ul> </li> </ul> </nav> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>TensorFlow Neuron (tensorflow-neuron (TF2.x)) Release Notes</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> <div> <h2> Contents </h2> </div> <nav aria-label="Page"> <ul class="visible nav section-nav flex-column"> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#known-issues-and-limitations-updated-08-12-2021"> Known Issues and Limitations - updated 08/12/2021 </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-10-1-0"> tensorflow-neuron 2.x release [2.10.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-9-3-0"> tensorflow-neuron 2.x release [2.9.3.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-8-9-0"> tensorflow-neuron 2.x release [2.8.9.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-8-1-0"> tensorflow-neuron 2.x release [2.8.1.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-7-4-0"> tensorflow-neuron 2.x release [2.7.4.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-7-3-0"> tensorflow-neuron 2.x release [2.7.3.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-6-5-0"> tensorflow-neuron 2.x release [2.6.5.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-6-0-0"> tensorflow-neuron 2.x release [2.6.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-4-0-0"> tensorflow-neuron 2.x release [2.4.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-3-0-0"> tensorflow-neuron 2.x release [2.3.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-2-0-0"> tensorflow-neuron 2.x release [2.2.0.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-1-14-0"> tensorflow-neuron 2.x release [2.1.14.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-1-13-0"> tensorflow-neuron 2.x release [2.1.13.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-1-6-0"> tensorflow-neuron 2.x release [2.1.6.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-0-4-0"> tensorflow-neuron 2.x release [2.0.4.0] </a> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-2-0-3-0"> tensorflow-neuron 2.x release [2.0.3.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#new-in-this-release"> New in this release </a> </li> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#resolved-issues"> Resolved Issues </a> </li> </ul> </li> <li class="toc-h2 nav-item toc-entry"> <a class="reference internal nav-link" href="#tensorflow-neuron-2-x-release-1-6-8-0"> tensorflow-neuron 2.x release [1.6.8.0] </a> <ul class="nav section-nav flex-column"> <li class="toc-h3 nav-item toc-entry"> <a class="reference internal nav-link" href="#id2"> New in this release </a> </li> </ul> </li> </ul> </nav> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> <div class="section" id="tensorflow-neuron-tensorflow-neuron-tf2-x-release-notes"> <span id="tensorflow-neuron-rn-v2"></span><h1>TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF2.x)</span></code>) Release Notes<a class="headerlink" href="#tensorflow-neuron-tensorflow-neuron-tf2-x-release-notes" title="Permalink to this headline">#</a></h1> <div class="contents local topic" id="table-of-contents"> <p class="topic-title">Table of contents</p> <ul class="simple"> <li><p><a class="reference internal" href="#known-issues-and-limitations-updated-08-12-2021" id="id3">Known Issues and Limitations - updated 08/12/2021</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-10-1-0" id="id4">tensorflow-neuron 2.x release [2.10.1.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-9-3-0" id="id5">tensorflow-neuron 2.x release [2.9.3.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-8-9-0" id="id6">tensorflow-neuron 2.x release [2.8.9.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-8-1-0" id="id7">tensorflow-neuron 2.x release [2.8.1.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-7-4-0" id="id8">tensorflow-neuron 2.x release [2.7.4.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-7-3-0" id="id9">tensorflow-neuron 2.x release [2.7.3.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-6-5-0" id="id10">tensorflow-neuron 2.x release [2.6.5.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-6-0-0" id="id11">tensorflow-neuron 2.x release [2.6.0.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-4-0-0" id="id12">tensorflow-neuron 2.x release [2.4.0.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-3-0-0" id="id13">tensorflow-neuron 2.x release [2.3.0.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-2-0-0" id="id14">tensorflow-neuron 2.x release [2.2.0.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-1-14-0" id="id15">tensorflow-neuron 2.x release [2.1.14.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-1-13-0" id="id16">tensorflow-neuron 2.x release [2.1.13.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-1-6-0" id="id17">tensorflow-neuron 2.x release [2.1.6.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-0-4-0" id="id18">tensorflow-neuron 2.x release [2.0.4.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-2-0-3-0" id="id19">tensorflow-neuron 2.x release [2.0.3.0]</a></p></li> <li><p><a class="reference internal" href="#tensorflow-neuron-2-x-release-1-6-8-0" id="id20">tensorflow-neuron 2.x release [1.6.8.0]</a></p></li> </ul> </div> <p>This document lists the release notes for the tensorflow-neuron 2.x packages.</p> <div class="section" id="known-issues-and-limitations-updated-08-12-2021"> <span id="tf-known-issues-and-limitations"></span><h2><a class="toc-backref" href="#id3">Known Issues and Limitations - updated 08/12/2021</a><a class="headerlink" href="#known-issues-and-limitations-updated-08-12-2021" title="Permalink to this headline">#</a></h2> <ul class="simple"> <li><p>Support on serialized TensorFlow 2.x custom operators is currently limited. Serializing some operators registered from tensorflow-text through <a class="reference external" href="https://tfhub.dev/">TensorFlow Hub</a> is going to cause failure in tensorflow.neuron.trace.</p></li> <li><p>Memory leak exists on latest releases of TensorFlow Neuron for versions 2.1, 2.2, 2.3, and 2.4.</p></li> <li><p>Issue: When compiling large models, user might run out of memory and encounter this fatal error.</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">terminate</span> <span class="n">called</span> <span class="n">after</span> <span class="n">throwing</span> <span class="n">an</span> <span class="n">instance</span> <span class="n">of</span> <span class="s1">'std::bad_alloc'</span> </pre></div> </div> <p>Solution: run compilation on a c5.4xlarge instance type or larger.</p> <ul class="simple"> <li><p>Issue: When upgrading <code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code> with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">tensorflow-neuron</span> <span class="pre">--upgrade</span></code>, the following error message may appear, which is caused by <code class="docutils literal notranslate"><span class="pre">pip</span></code> version being too low.</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Could</span> <span class="ow">not</span> <span class="n">find</span> <span class="n">a</span> <span class="n">version</span> <span class="n">that</span> <span class="n">satisfies</span> <span class="n">the</span> <span class="n">requirement</span> <span class="n">tensorflow</span><span class="o">&lt;</span><span class="mf">1.16.0</span><span class="p">,</span><span class="o">&gt;=</span><span class="mf">1.15.0</span> <span class="p">(</span><span class="kn">from</span> <span class="nn">tensorflow</span><span class="o">-</span><span class="n">neuron</span><span class="p">)</span> </pre></div> </div> <p>Solution: run a <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pip</span> <span class="pre">--upgrade</span></code> before upgrading <code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>.</p> <ul class="simple"> <li><p>Issue: Some Keras routines throws the following error:</p></li> </ul> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ne">AttributeError</span><span class="p">:</span> <span class="s1">'str'</span> <span class="nb">object</span> <span class="n">has</span> <span class="n">no</span> <span class="n">attribute</span> <span class="s1">'decode'</span><span class="o">.</span> </pre></div> </div> <p>Solution: Please downgrade <cite>h5py</cite> by <cite>pip install ‘h5py&lt;3’</cite>. This is caused by <a class="reference external" href="https://github.com/TensorFlow/TensorFlow/issues/44467">https://github.com/TensorFlow/TensorFlow/issues/44467</a>.</p> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-10-1-0"> <h2><a class="toc-backref" href="#id4">tensorflow-neuron 2.x release [2.10.1.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-10-1-0" title="Permalink to this headline">#</a></h2> <p>Date: 09/15/2023</p> <ul class="simple"> <li><p>Minor updates.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-9-3-0"> <h2><a class="toc-backref" href="#id5">tensorflow-neuron 2.x release [2.9.3.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-9-3-0" title="Permalink to this headline">#</a></h2> <p>Date: 7/19/2023</p> <ul class="simple"> <li><p>Minor updates.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-8-9-0"> <h2><a class="toc-backref" href="#id6">tensorflow-neuron 2.x release [2.8.9.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-8-9-0" title="Permalink to this headline">#</a></h2> <p>Date: 6/14/2023</p> <ul class="simple"> <li><p>Added Python 3.10 support.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-8-1-0"> <h2><a class="toc-backref" href="#id7">tensorflow-neuron 2.x release [2.8.1.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-8-1-0" title="Permalink to this headline">#</a></h2> <p>Date: 05/01/2023</p> <ul class="simple"> <li><p>Added support for tracing models larger than 2 GB through the environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--extract-weights</span> <span class="pre">INSTANCE_TYPE'</span></code> for all inf1 instance types.</p></li> <li><p>Neuron release 2.10 release will be the last release that will include support for tensorflow-neuron version 2.7. Future Neuron releases will not include tensorflow-neuron version 2.7.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-7-4-0"> <h2><a class="toc-backref" href="#id8">tensorflow-neuron 2.x release [2.7.4.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-7-4-0" title="Permalink to this headline">#</a></h2> <p>Date: 04/19/2023</p> <ul class="simple"> <li><p>Minor updates.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-7-3-0"> <h2><a class="toc-backref" href="#id9">tensorflow-neuron 2.x release [2.7.3.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-7-3-0" title="Permalink to this headline">#</a></h2> <p>Date: 03/28/2023</p> <ul class="simple"> <li><p>Introduce the <code class="docutils literal notranslate"><span class="pre">tfn.analyze_model</span></code> function that displays information about the supported and unsupported operators of a traceable model.</p></li> <li><p>Introduce the <code class="docutils literal notranslate"><span class="pre">on_neuron_ratio</span></code> attribute of AWS Optimized Neuron Models returned by <code class="docutils literal notranslate"><span class="pre">tfn.trace</span></code>, which is the percentage of ops on neuron after compilation.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-6-5-0"> <h2><a class="toc-backref" href="#id10">tensorflow-neuron 2.x release [2.6.5.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-6-5-0" title="Permalink to this headline">#</a></h2> <p>Date: 02/24/2023</p> <ul class="simple"> <li><p>Minor updates.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-6-0-0"> <h2><a class="toc-backref" href="#id11">tensorflow-neuron 2.x release [2.6.0.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-6-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 2/24/2023</p> <ul class="simple"> <li><p>Minor bug fixes.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-4-0-0"> <h2><a class="toc-backref" href="#id12">tensorflow-neuron 2.x release [2.4.0.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-4-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 11/22/2022</p> <ul class="simple"> <li><p>Experimental support for tracing models larger than 2 GB through environment variable <code class="docutils literal notranslate"><span class="pre">NEURON_CC_FLAGS='--extract-weights'</span></code>.</p></li> <li><p>Introduce <code class="docutils literal notranslate"><span class="pre">tfn.auto_multicore</span></code> Python API to enable automatic data parallel on multiple NeuronCores.</p></li> <li><p>Introduce <code class="docutils literal notranslate"><span class="pre">tf-neuron-auto-multicore</span></code> tool to enable automatic data parallel on multiple NeuronCores.</p></li> <li><p>Deprecated the NEURONCORE_GROUP_SIZES environment variable.</p></li> <li><p>Minor bug fixes.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-3-0-0"> <h2><a class="toc-backref" href="#id13">tensorflow-neuron 2.x release [2.3.0.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-3-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 04/29/2022</p> <ul class="simple"> <li><p>Added support for Tensorflow 2.8.0.</p></li> <li><p>Added support for Slice operator</p></li> <li><p>The graph partitioner now prefers to place less compute intensive operators on CPU if the model already contains a large amount of compute intensive operators.</p></li> <li><p>Fixed <a class="reference external" href="https://github.com/aws/aws-neuron-sdk/issues/408">Github issue #408</a>, the fix solves data type handling bug in <code class="docutils literal notranslate"><span class="pre">tfn.trace</span></code> when the model contains Conv2D operators.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-2-0-0"> <h2><a class="toc-backref" href="#id14">tensorflow-neuron 2.x release [2.2.0.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-2-0-0" title="Permalink to this headline">#</a></h2> <p>Date: 03/25/2022</p> <ul class="simple"> <li><p>Updated TensorFlow 2.5 to version 2.5.3.</p></li> <li><p>Added support for TensorFlow 2.6 and 2.7.</p></li> <li><p>Added a warning message when calling <code class="docutils literal notranslate"><span class="pre">tfn.saved_model.compile</span></code> API. In tensorflow-neuron 2.x you should call <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html#tensorflow-ref-neuron-tracing-api"><span class="std std-ref">tensorflow.neuron.trace</span></a>. <code class="docutils literal notranslate"><span class="pre">tfn.saved_model.compile</span></code> API supports only partial functionality of <a class="reference internal" href="../../../frameworks/tensorflow/tensorflow-neuron/api-tracing-python-api.html#tensorflow-ref-neuron-tracing-api"><span class="std std-ref">tensorflow.neuron.trace</span></a> and will be deprecated in the future.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-1-14-0"> <h2><a class="toc-backref" href="#id15">tensorflow-neuron 2.x release [2.1.14.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-1-14-0" title="Permalink to this headline">#</a></h2> <p>Date: 02/17/2022</p> <ul class="simple"> <li><p>Fixed a bug in TensorFlow Neuron versions 2.1, 2.2. 2.3 and 2.4. The fixed bug was causing a memory leak of 128 bytes for each inference.</p></li> <li><p>Improved warning message when calling deprecated compilation API under tensorflow-neuron 2.x.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-1-13-0"> <h2><a class="toc-backref" href="#id16">tensorflow-neuron 2.x release [2.1.13.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-1-13-0" title="Permalink to this headline">#</a></h2> <p>Date: 02/16/2022</p> <ul class="simple"> <li><p>Fixed a bug that caused a memory leak. The memory leak was approximately 128b for each inference and exists in all versions of TensorFlow Neuron versions part of Neuron 1.16.0 to Neuron 1.17.0 releases. see <a class="reference internal" href="../../prev/content.html#pre-release-content"><span class="std std-ref">Previous Releases Artifacts (Neuron 2.x)</span></a> for exact versions included in each release. This release only addresses the leak in TensorFlow Neuron 2.5. Future release of TensorFlow Neuron will fix the leak in other versions as well (2.1, 2.2, 2.3, 2.4).</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-1-6-0"> <h2><a class="toc-backref" href="#id17">tensorflow-neuron 2.x release [2.1.6.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-1-6-0" title="Permalink to this headline">#</a></h2> <p>Date: 01/20/2022</p> <ul class="simple"> <li><p>Updated TensorFlow 2.5 to version 2.5.2.</p></li> <li><p>Enhanced auto data parallel (e.g. when using NEURONCORE_GROUP_SIZES=X,Y,Z,W) to support edge cases.</p></li> <li><p>Fixed a bug that may cause tensorflow-neuron to generate in some cases scalar gather instruction with incorrect arguments.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-0-4-0"> <h2><a class="toc-backref" href="#id18">tensorflow-neuron 2.x release [2.0.4.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-0-4-0" title="Permalink to this headline">#</a></h2> <p>Date: 11/05/2021</p> <ul class="simple"> <li><p>Updated Neuron Runtime (which is integrated within this package) to <code class="docutils literal notranslate"><span class="pre">libnrt</span> <span class="pre">2.2.18.0</span></code> to fix a container issue that was preventing the use of containers when /dev/neuron0 was not present. See details here <span class="xref std std-ref">neuron-runtime-release-notes</span>.</p></li> </ul> </div> <div class="section" id="tensorflow-neuron-2-x-release-2-0-3-0"> <h2><a class="toc-backref" href="#id19">tensorflow-neuron 2.x release [2.0.3.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-2-0-3-0" title="Permalink to this headline">#</a></h2> <p>Date: 10/27/2021</p> <div class="section" id="new-in-this-release"> <h3>New in this release<a class="headerlink" href="#new-in-this-release" title="Permalink to this headline">#</a></h3> <ul> <li><p>TensorFlow 2.x (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span></code>) now support Neuron Runtime 2.x (<code class="docutils literal notranslate"><span class="pre">libnrt.so</span></code> shared library) only.</p> <blockquote> <div><div class="admonition important"> <p class="admonition-title">Important</p> <ul class="simple"> <li><p>You must update to the latest Neuron Driver (<code class="docutils literal notranslate"><span class="pre">aws-neuron-dkms</span></code> version 2.1 or newer) for proper functionality of the new runtime library.</p></li> <li><p>Read <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt"><span class="std std-ref">Introducing Neuron Runtime 2.x (libnrt.so)</span></a> application note that describes <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-why"><span class="std std-ref">why are we making this change</span></a> and how <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#introduce-libnrt-how-sdk"><span class="std std-ref">this change will affect the Neuron SDK</span></a> in detail.</p></li> <li><p>Read <a class="reference internal" href="../../../general/appnotes/neuron1x/introducing-libnrt.html#neuron-migrating-apps-neuron-to-libnrt"><span class="std std-ref">Migrate your application to Neuron Runtime 2.x (libnrt.so)</span></a> for detailed information of how to migrate your application.</p></li> </ul> </div> </div></blockquote> </li> <li><p>Updated TensorFlow 2.3.x from TensorFlow 2.3.3 to TensorFlow 2.3.4.</p></li> <li><p>Updated TensorFlow 2.4.x from TensorFlow 2.4.2 to TensorFlow 2.4.3.</p></li> <li><p>Updated TensorFlow 2.5.x from TensorFlow 2.5.0 to TensorFlow 2.5.1.</p></li> </ul> </div> <div class="section" id="resolved-issues"> <h3>Resolved Issues<a class="headerlink" href="#resolved-issues" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>Fix bug that can cause illegal compiler optimizations</p></li> <li><p>Fix bug that can cause dynamic-shape operators be placed on Neuron</p></li> </ul> </div> </div> <div class="section" id="tensorflow-neuron-2-x-release-1-6-8-0"> <span id="id1"></span><h2><a class="toc-backref" href="#id20">tensorflow-neuron 2.x release [1.6.8.0]</a><a class="headerlink" href="#tensorflow-neuron-2-x-release-1-6-8-0" title="Permalink to this headline">#</a></h2> <p>Date: 08/12/2021</p> <div class="section" id="id2"> <h3>New in this release<a class="headerlink" href="#id2" title="Permalink to this headline">#</a></h3> <ul class="simple"> <li><p>First release of TensorFlow 2.x integration, Neuron support now TensorFlow versions 2.1.4, 2.2.3, 2.3.3, 2.4.2, and 2.5.0.</p></li> <li><p>New public API tensorflow.neuron.trace: trace a TensorFlow 2.x keras.Model or a Python callable that can be decorated by tf.function, and return an AWS-Neuron-optimized keras.Model that can execute on AWS Machine Learning Accelerators.</p></li> </ul> <blockquote> <div><p><strong>Please note</strong> that TensorFlow 1.x SavedModel compilation API tensorflow.neuron.saved_model.compile is not supported in tensorflow-neuron 2.x . It continues to function in tensorflow-neuron 1.15.x .</p> </div></blockquote> <ul> <li><p>Included versions:</p> <blockquote> <div><ul class="simple"> <li><p>tensorflow-neuron-2.5.0.1.6.8.0</p></li> <li><p>tensorflow-neuron-2.4.2.1.6.8.0</p></li> <li><p>tensorflow-neuron-2.3.3.1.6.8.0</p></li> <li><p>tensorflow-neuron-2.2.3.1.6.8.0</p></li> <li><p>tensorflow-neuron-2.1.4.1.6.8.0</p></li> </ul> </div></blockquote> </li> </ul> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code></p> </div> </div> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="tensorflow-neuron.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF1.x)</span></code>) Release Notes</p> </div> </a> <a class="right-next" id="next-link" href="../../../frameworks/tensorflow/tensorflow-neuron/tensorflow2-accelerated-ops.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF2.x)</span></code>) Accelerated (torch-neuron) Python APIs and Graph Ops</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:21.636Z
Training — AWS Neuron Documentation
https://awsdocs-neuron.readthedocs-hosted.com/en/v2.14.1/frameworks/tensorflow/training.html
# Training — AWS Neuron Documentation _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n` ## Training[#](#training "Permalink to this headline") Note TensorFlow Neuron support for Training is coming soon. _This document is relevant for_: `Inf1`, `Inf2`, `Trn1`, `Trn1n`
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Training — AWS Neuron Documentation</title> <!-- Loaded before other Sphinx assets --> <link href="../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link href="../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> <link rel="stylesheet" href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> <link rel="preload" as="font" type="font/woff2" crossorigin="" href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css"> <link rel="stylesheet" href="../../_static/styles/sphinx-book-theme.css?digest=5115cc725059bd94278eecd172e13a965bf8f5a9" type="text/css"> <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css"> <link rel="stylesheet" type="text/css" href="../../_static/styles/sphinx-book-theme.css"> <link rel="stylesheet" type="text/css" href="../../_static/contentui.css"> <link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css"> <link rel="stylesheet" type="text/css" href="/_/static/css/badge_only.css"> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> <script type="text/javascript" async="" src="https://www.googletagmanager.com/gtag/js?id=G-2Q13EGB80H&amp;l=dataLayer&amp;cx=c"></script><script type="text/javascript" async="" src="https://www.google-analytics.com/analytics.js"></script><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> <script src="../../_static/jquery.js"></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> <script src="../../_static/contentui.js"></script> <script src="../../_static/design-tabs.js"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script async="async" src="/_/static/javascript/readthedocs-doc-embed.js"></script> <link rel="index" title="Index" href="../../genindex.html"> <link rel="search" title="Search" href="../../search.html"> <link rel="next" title="MXNet Neuron" href="../mxnet-neuron/index.html"> <link rel="prev" title="TensorFlow Neuron (tensorflow-neuron (TF1.x)) Supported operators" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="docsearch:language" content="en"> <!-- Google Analytics --> <style type="text/css"> ul.ablog-archive { list-style: none; overflow: auto; margin-left: 0px; } ul.ablog-archive li { float: left; margin-right: 5px; font-size: 80%; } ul.postlist a { font-style: italic; } ul.postlist-style-disc { list-style-type: disc; } ul.postlist-style-none { list-style-type: none; } ul.postlist-style-circle { list-style-type: circle; } </style> <!-- RTD Extra Head --> <link rel="stylesheet" href="/_/static/css/readthedocs-doc-embed.css" type="text/css"> <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.com", "builder": "sphinx", "canonical_url": null, "docroot": "/", "features": {"docsearch_disabled": false}, "global_analytics_code": "UA-17997319-2", "language": "en", "page": "frameworks/tensorflow/training", "programming_language": "py", "project": "awsdocs-neuron", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_book_theme", "user_analytics_code": "G-2Q13EGB80H", "version": "v2.14.1"}</script> <!-- Using this variable directly instead of using `JSON.parse` is deprecated. The READTHEDOCS_DATA global variable will be removed in the future. --> <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script> <script type="text/javascript" src="/_/static/javascript/readthedocs-analytics.js" async="async"></script> <!-- end RTD <extrahead> --> <script src="https://www.googletagmanager.com/gtag/js?id=UA-17997319-2" type="text/javascript" async=""></script><meta http-equiv="origin-trial" content="AymqwRC7u88Y4JPvfIF2F37QKylC04248hLCdJAsh8xgOfe/dVJPV3XS3wLFca1ZMVOtnBfVjaCMTVudWM//5g4AAAB7eyJvcmlnaW4iOiJodHRwczovL3d3dy5nb29nbGV0YWdtYW5hZ2VyLmNvbTo0NDMiLCJmZWF0dXJlIjoiUHJpdmFjeVNhbmRib3hBZHNBUElzIiwiZXhwaXJ5IjoxNjk1MTY3OTk5LCJpc1RoaXJkUGFydHkiOnRydWV9"></head> <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="60"> <!-- Checkboxes to toggle the left sidebar --> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle navigation sidebar"> <label class="overlay overlay-navbar" for="__navigation"> <div class="visually-hidden">Toggle navigation sidebar</div> </label> <!-- Checkboxes to toggle the in-page toc --> <input type="checkbox" class="sidebar-toggle" name="__page-toc" id="__page-toc" aria-label="Toggle in-page Table of Contents"> <label class="overlay overlay-pagetoc" for="__page-toc"> <div class="visually-hidden">Toggle in-page Table of Contents</div> </label> <!-- Headers at the top --> <div class="announcement header-item noprint">Neuron 2.14.0 is released! check <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html#latest-neuron-release"> What's New </a> and <a class="reference internal" style="color:white;" href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/general/announcements/index.html"> Announcements </a></div> <div class="header header-item noprint"></div> <div class="container-fluid" id="banner"></div> <div class="container-xl"> <div class="row"> <!-- Sidebar --> <div class="bd-sidebar noprint" id="site-navigation"> <div class="bd-sidebar__content"> <div class="bd-sidebar__top"><div class="navbar-brand-box"> <a class="navbar-brand text-wrap" href="../../index.html"> <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 --> <img src="../../_static/Site-Merch_Neuron-ML-SDK_Editorial.png" class="logo" alt="logo"> <h1 class="site-logo" id="site-title">AWS Neuron Documentation</h1> </a> </div><form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> <i class="icon fas fa-search"></i> <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off"> </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main"> <div class="bd-toc-item active"> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Overview </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/docs-quicklinks.html"> Quick Links </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/index.html"> Get Started with Neuron </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/quick-start/github-samples.html"> GitHub Samples </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/benchmarks/index.html"> Performance </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/index.html"> What’s New </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/announcements/index.html"> Announcements </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Frameworks </span> </p> <ul class="current nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../torch/index.html"> PyTorch Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"> <label for="toctree-checkbox-1"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../torch/torch-setup.html"> Pytorch Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuronx.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"> <label for="toctree-checkbox-2"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorials-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"> <label for="toctree-checkbox-3"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/bert-base-cased-finetuned-mrpc-inference-on-trn1-tutorial.html"> Compiling and Deploying HuggingFace Pretrained BERT on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/inference/tutorial-torchserve-neuronx.html"> BERT TorchServe Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorial-libtorch.html"> LibTorch C++ Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/resnet50-inference-on-trn1-tutorial.html"> Compiling and Deploying ResNet50 on Trn1 or Inf2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/pytorch/torch-neuronx/t5-inference-tutorial.html"> T5 model inference on Trn1 or Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-inference-torch-neuronx.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"> <label for="toctree-checkbox-4"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/"> AWS Neuron Samples GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/transformers-neuronx"> Transformers Neuron GitHub samples </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/inference-api-guide-torch-neuronx.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"> <label for="toctree-checkbox-5"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-trace.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Tracing API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) NeuronCore Placement APIs <strong> [Experimental] </strong> </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-analyze.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Analyze API for Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/inference/api-torch-neuronx-data-parallel.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) DataParallel API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"> <label for="toctree-checkbox-6"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/core-placement.html"> NeuronCore Allocation and Model Placement for Inference ( <span class="xref std std-ref"> torch-neuronx </span> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/inference/trace-vs-xla-lazytensor.html"> Comparison of Traced Inference versus XLA <span class="xref std std-ref"> Lazy Tensor </span> Inference ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuronx/torch-neuronx-dataparallel-app-note.html"> Data Parallel Inference on torch_neuronx </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-inference-torch-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"> <label for="toctree-checkbox-7"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/inference-torch-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"> <label for="toctree-checkbox-8"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-inference-torch-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"> <label for="toctree-checkbox-9"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-torch-neuron-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/tutorials/tutorials-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/additional-examples-inference-torch-neuron.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"> <label for="toctree-checkbox-10"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/api-reference-guide-torch-neuron.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"> <label for="toctree-checkbox-11"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-compilation-python-api.html"> PyTorch Neuron trace Python API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-torch-neuron-dataparallel-api.html"> torch.neuron.DataParallel API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/api-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement API [Experimental] </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/developer-guide-torch-neuron.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"> <label for="toctree-checkbox-12"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/bucketing-app-note.html"> Running Inference on Variable Input Shapes with Bucketing </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/torch-neuron/torch-neuron-dataparallel-app-note.html"> Data Parallel Inference on PyTorch Neuron </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/torch-lstm-support.html"> Developer Guide - PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) <code class="xref py py-class docutils literal notranslate"> <span class="pre"> LSTM </span> </code> Support </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/guides/core-placement/torch-core-placement.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Core Placement </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuron/misc-inference-torch-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"> <label for="toctree-checkbox-13"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-pytorch.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) Supported operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuron/troubleshooting-guide.html"> Troubleshooting Guide for PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuron/torch-neuron.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuron </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../torch/training-torch-neuronx.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"> <label for="toctree-checkbox-14"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/tutorials-training-torch-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"> <label for="toctree-checkbox-15"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/bert.html"> Hugging Face BERT Pretraining Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/mlp.html"> Multi-Layer Perceptron Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_hftrainer.html"> PyTorch Neuron for Trainium Hugging Face BERT MRPC task finetuning using Hugging Face Trainer API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/finetune_t5.html"> Fine-tune T5 model on Trn1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/zero1_gpt2.html"> ZeRO-1 Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/tutorials/training/analyze_for_training.html"> Analyze for Training Tutorial </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/additional-examples-training.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"> <label for="toctree-checkbox-16"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/neuronx-nemo-megatron"> AWS Neuron Reference for Nemo Megatron GitHub Repository </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-eks-samples"> AWS Neuron Samples for EKS </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-parallelcluster-samples"> AWS Neuron Samples for AWS ParallelCluster </a> </li> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/torch-neuronx/training"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/index.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"> <label for="toctree-checkbox-17"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/pytorch-neuron-parallel-compile.html"> PyTorch Neuron neuron_parallel_compile CLI ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/training/torch-neuron-envvars.html"> PyTorch Neuron Environment Variables ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/api-reference-guide/torch-neuronx-profiling-api.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) Profiling API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/index.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"> <label for="toctree-checkbox-18"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-programming-guide.html"> Developer Guide for Training with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/training/pytorch-neuron-debug.html"> How to debug models in PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/programming-guide/torch-neuronx-profiling-dev-guide.html"> Developer Guide for Profiling with PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../torch/torch-neuronx/misc-training.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"> <label for="toctree-checkbox-19"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/pytorch-neuron-supported-operators.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) - Supported Operators </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/setup-trn1-multi-node-execution.html"> How to prepare trn1.32xlarge for multi-node execution </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../torch/torch-neuronx/training-troubleshooting.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) for Training Troubleshooting Guide </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/torch/torch-neuronx/index.html"> PyTorch Neuron ( <code class="docutils literal notranslate"> <span class="pre"> torch-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 current active has-children"> <a class="reference internal" href="index.html"> TensorFlow Neuron </a> <input checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"> <label for="toctree-checkbox-20"> <i class="fas fa-chevron-down"> </i> </label> <ul class="current"> <li class="toctree-l2"> <a class="reference internal" href="tensorflow-setup.html"> Tensorflow Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tensorflow-neuronx-inference.html"> Inference (Inf2 &amp; Trn1) </a> <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"> <label for="toctree-checkbox-21"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorials-tensorflow-neuronx.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"> <label for="toctree-checkbox-22"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../src/examples/tensorflow/tensorflow-neuronx/tfneuronx-roberta-base-tutorial.html"> HuggingFace Roberta-Base </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tutorials/tutorial-tensorflowx-serving-NeuronRT-Visible-Cores.html"> Using NEURON_RT_VISIBLE_CORES with TensorFlow Serving </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"> <label for="toctree-checkbox-23"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfneuronx-python-tracing-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tf-neuronx-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuronx/tfnx-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) analyze_model API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuronx/misc-tensorflow-neuronx.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" type="checkbox"> <label for="toctree-checkbox-24"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuronx/tensorflow-neuronx.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuronx </span> </code> ) Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="tensorflow-neuron-inference.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" type="checkbox"> <label for="toctree-checkbox-25"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" type="checkbox"> <label for="toctree-checkbox-26"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tutorials/tutorials-tensorflow-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/additional-examples.html"> Additional Examples </a> <input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" type="checkbox"> <label for="toctree-checkbox-27"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/tree/master/tensorflow-neuron/inference"> AWS Neuron Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" type="checkbox"> <label for="toctree-checkbox-28"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tracing-python-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Tracing API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-tfn-analyze-model-api.html"> TensorFlow 2.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) analyze_model API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-compilation-python-api.html"> TensorFlow 1.x ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Compilation API </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/api-auto-replication-api.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> </code> ) Auto Multicore Replication (Experimental) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="tensorflow-neuron/misc-tensorflow-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" type="checkbox"> <label for="toctree-checkbox-29"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tensorflow/tensorflow-neuron/tensorflow-neuron-v2.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="tensorflow-neuron/tensorflow2-accelerated-ops.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF2.x) </span> </code> ) Accelerated (torch-neuron) Python APIs and Graph Ops </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html"> TensorFlow Neuron ( <code class="docutils literal notranslate"> <span class="pre"> tensorflow-neuron </span> <span class="pre"> (TF1.x) </span> </code> ) Supported operators </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 current active"> <a class="current reference internal" href="#"> Training </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../mxnet-neuron/index.html"> Apache MXNet (Incubating) </a> <input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" type="checkbox"> <label for="toctree-checkbox-30"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../mxnet-neuron/mxnet-neuron-setup.html"> MXNet Neuron Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../mxnet-neuron/inference-mxnet-neuron.html"> Inference (Inf1) </a> <input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" type="checkbox"> <label for="toctree-checkbox-31"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-neuron.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" type="checkbox"> <label for="toctree-checkbox-32"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-computervision.html"> Computer Vision Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-nlp.html"> Natural Language Processing (NLP) Tutorials </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/tutorials/tutorials-mxnet-utilizing-neuron-capabilities.html"> Utilizing Neuron Capabilities Tutorials </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" type="checkbox"> <label for="toctree-checkbox-33"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/api-compilation-python-api.html"> Neuron Apache MXNet (Incubating) Compilation Python API </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" type="checkbox"> <label for="toctree-checkbox-34"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/mxnet-neuron/flex-eg.html"> Flexible Execution Group (FlexEG) in Neuron-MXNet </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../mxnet-neuron/misc-mxnet-neuron.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" type="checkbox"> <label for="toctree-checkbox-35"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../mxnet-neuron/troubleshooting-guide.html"> Troubleshooting Guide for Neuron Apache MXNet (Incubating) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/mxnet-neuron/mxnet-neuron.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-mxnet.html"> Neuron Apache MXNet (Incubating) Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> ML Libraries </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/index.html"> Transformers Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-36" name="toctree-checkbox-36" type="checkbox"> <label for="toctree-checkbox-36"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/transformers-neuronx/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-37" name="toctree-checkbox-37" type="checkbox"> <label for="toctree-checkbox-37"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-developer-guide.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) Developer Guide </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-38" name="toctree-checkbox-38" type="checkbox"> <label for="toctree-checkbox-38"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/meta-llama-2-13b-sampling.ipynb"> Hugging Face meta-llama/Llama-2-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-13b-sampling.ipynb"> Hugging Face facebook/opt-13b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-30b-sampling.ipynb"> Hugging Face facebook/opt-30b autoregressive sampling on Inf2 &amp; Trn1 </a> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-samples/blob/master/torch-neuronx/transformers-neuronx/inference/facebook-opt-66b-sampling.ipynb"> Hugging Face facebook/opt-66b autoregressive sampling on Inf2 </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/transformers-neuronx/transformers-neuronx-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-39" name="toctree-checkbox-39" type="checkbox"> <label for="toctree-checkbox-39"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/torch/transformers-neuronx/index.html"> Transformers Neuron ( <code class="docutils literal notranslate"> <span class="pre"> transformers-neuronx </span> </code> ) release notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/index.html"> Neuron Distributed </a> <input class="toctree-checkbox" id="toctree-checkbox-40" name="toctree-checkbox-40" type="checkbox"> <label for="toctree-checkbox-40"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../libraries/neuronx-distributed/setup/index.html"> Setup </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/app_notes.html"> App Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-41" name="toctree-checkbox-41" type="checkbox"> <label for="toctree-checkbox-41"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tensor_parallelism_overview.html"> Tensor Parallelism Overview </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-42" name="toctree-checkbox-42" type="checkbox"> <label for="toctree-checkbox-42"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/api_guide.html"> API Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-43" name="toctree-checkbox-43" type="checkbox"> <label for="toctree-checkbox-43"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tp_developer_guide.html"> Developer guide for Tensor Parallelism ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/index.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-44" name="toctree-checkbox-44" type="checkbox"> <label for="toctree-checkbox-44"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training.html"> Training using Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox.html"> Training GPT-NeoX 6.9B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/training-gpt-neox-20b.html"> Training GPT-NeoX 20B using TP and ZeRO-1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../src/examples/pytorch/neuronx_distributed/t5-inference/t5-inference-tutorial.html"> T5 inference with Tensor Parallelism </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../libraries/neuronx-distributed/tutorials/inference.html"> Inference using Tensor Parallelism </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../libraries/neuronx-distributed/neuronx-distributed-misc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-45" name="toctree-checkbox-45" type="checkbox"> <label for="toctree-checkbox-45"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/neuronx-distributed/neuronx-distributed.html"> Neuron Distributed Release Notes ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-distributed </span> </code> ) </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../libraries/nemo-megatron/index.html"> AWS Neuron Reference for NeMo Megatron </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> User Guide </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-runtime/index.html"> Neuron Runtime </a> <input class="toctree-checkbox" id="toctree-checkbox-46" name="toctree-checkbox-46" type="checkbox"> <label for="toctree-checkbox-46"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-47" name="toctree-checkbox-47" type="checkbox"> <label for="toctree-checkbox-47"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-api-guide.html"> Runtime API </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/configuration-guide.html"> Configuration Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-48" name="toctree-checkbox-48" type="checkbox"> <label for="toctree-checkbox-48"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-configurable-parameters.html"> Runtime Configuration </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-runtime/misc-runtime.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-49" name="toctree-checkbox-49" type="checkbox"> <label for="toctree-checkbox-49"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/nrt-troubleshoot.html"> Troubleshooting on Inf1 and Trn1 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-runtime/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-runtime-lib/index.html"> Neuron Runtime Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-dkms/index.html"> Neuron Driver Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/runtime/aws-neuronx-collectives/index.html"> Neuron Collectives Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../compiler/index.html"> Neuron Compiler </a> <input class="toctree-checkbox" id="toctree-checkbox-50" name="toctree-checkbox-50" type="checkbox"> <label for="toctree-checkbox-50"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc.html"> Neuron Compiler for Trn1 &amp; Inf2 </a> <input class="toctree-checkbox" id="toctree-checkbox-51" name="toctree-checkbox-51" type="checkbox"> <label for="toctree-checkbox-51"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-52" name="toctree-checkbox-52" type="checkbox"> <label for="toctree-checkbox-52"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-53" name="toctree-checkbox-53" type="checkbox"> <label for="toctree-checkbox-53"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuronx-cc/neuronx-cc-training-mixed-precision.html"> Mixed Precision and Performance-accuracy Tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuronx-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuronx-cc/misc-neuronx-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-54" name="toctree-checkbox-54" type="checkbox"> <label for="toctree-checkbox-54"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuronx-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuronx-cc/index.html"> What's New </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../compiler/neuron-cc.html"> Neuron Compiler for Inf1 </a> <input class="toctree-checkbox" id="toctree-checkbox-55" name="toctree-checkbox-55" type="checkbox"> <label for="toctree-checkbox-55"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-56" name="toctree-checkbox-56" type="checkbox"> <label for="toctree-checkbox-56"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/command-line-reference.html"> Neuron compiler CLI Reference Guide ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/developer-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-57" name="toctree-checkbox-57" type="checkbox"> <label for="toctree-checkbox-57"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/appnotes/neuron-cc/mixed-precision.html"> Mixed precision and performance-accuracy tuning ( <code class="docutils literal notranslate"> <span class="pre"> neuron-cc </span> </code> ) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../compiler/neuron-cc/misc-neuron-cc.html"> Misc </a> <input class="toctree-checkbox" id="toctree-checkbox-58" name="toctree-checkbox-58" type="checkbox"> <label for="toctree-checkbox-58"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../compiler/neuron-cc/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc.html"> What's New </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/index.html"> Neuron Supported operators </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../neuron-customops/index.html"> Neuron C++ Custom Operators </a> <input class="toctree-checkbox" id="toctree-checkbox-59" name="toctree-checkbox-59" type="checkbox"> <label for="toctree-checkbox-59"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/api-reference-guide.html"> API Reference Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-60" name="toctree-checkbox-60" type="checkbox"> <label for="toctree-checkbox-60"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/api-reference-guide/custom-ops-ref-guide.html"> Custom Operators API Reference Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/programming-guide/programming-guide.html"> Developer Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-61" name="toctree-checkbox-61" type="checkbox"> <label for="toctree-checkbox-61"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/programming-guide/custom-c%2B%2B-operators-devguide.html"> Neuron Custom C++ Operators Developer Guide [Experimental] </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/tutorials/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-62" name="toctree-checkbox-62" type="checkbox"> <label for="toctree-checkbox-62"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-training.html"> Neuron Custom C++ Operators in MLP Training </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../neuron-customops/tutorials/customop-mlp-perf-opt.html"> Neuron Custom C++ Operators Performance Optimization </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../neuron-customops/misc-customops.html"> Misc (Neuron Custom C++ Operators) </a> <input class="toctree-checkbox" id="toctree-checkbox-63" name="toctree-checkbox-63" type="checkbox"> <label for="toctree-checkbox-63"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-tools.html"> Neuron Custom C++ Tools Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/customcxxps/gpsimd-customop-lib.html"> Neuron Custom C++ Library Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../tools/index.html"> Neuron Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-64" name="toctree-checkbox-64" type="checkbox"> <label for="toctree-checkbox-64"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuron-sys-tools/index.html"> System Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-65" name="toctree-checkbox-65" type="checkbox"> <label for="toctree-checkbox-65"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-monitor-user-guide.html"> Neuron-Monitor User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-top-user-guide.html"> Neuron-Top User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-ls.html"> Neuron-LS User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-profile-user-guide.html"> Neuron Profile User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/neuron-sysfs-user-guide.html"> Neuron-Sysfs User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuron-sys-tools/nccom-test.html"> NCCOM-TEST User Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/aws-neuronx-tools.html"> What's New </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/tensorboard/index.html"> TensorBoard </a> <input class="toctree-checkbox" id="toctree-checkbox-66" name="toctree-checkbox-66" type="checkbox"> <label for="toctree-checkbox-66"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tutorials/tutorial-tensorboard-scalars-mnist.html"> Track Training Progress in TensorBoard using PyTorch Neuron </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuronx-plugin.html"> TensorBoard Plugin for Neuron (Trn1) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/tools/tensorboard-neuron.html"> What's New </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/tensorboard/getting-started-tensorboard-neuron-plugin.html"> TensorBoard Plugin for Neuron (Inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/helper-tools/index.html"> Helper Tools </a> <input class="toctree-checkbox" id="toctree-checkbox-67" name="toctree-checkbox-67" type="checkbox"> <label for="toctree-checkbox-67"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-check-model.html"> Check Model </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/helper-tools/tutorial-neuron-gatherinfo.html"> GatherInfo </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../tools/neuronperf/index.html"> NeuronPerf (Beta) </a> <input class="toctree-checkbox" id="toctree-checkbox-68" name="toctree-checkbox-68" type="checkbox"> <label for="toctree-checkbox-68"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_overview.html"> Overview </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_terminology.html"> Terminology </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_examples.html"> Examples </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_benchmark_guide.html"> Benchmark Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_evaluate_guide.html"> Evaluate Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_compile_guide.html"> Compile Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_model_index_guide.html"> Model Index Guide </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_api.html"> API </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_framework_notes.html"> Framework Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../tools/neuronperf/neuronperf_troubleshooting.html"> Troubleshooting </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../tools/neuronperf/rn.html"> What’s New </a> <input class="toctree-checkbox" id="toctree-checkbox-69" name="toctree-checkbox-69" type="checkbox"> <label for="toctree-checkbox-69"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/tools/neuronperf.html"> NeuronPerf 1.x Release Notes </a> </li> </ul> </li> </ul> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/calculator/neuron-calculator.html"> Neuron Calculator </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/setup/index.html"> Setup Guide </a> <input class="toctree-checkbox" id="toctree-checkbox-70" name="toctree-checkbox-70" type="checkbox"> <label for="toctree-checkbox-70"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuronx.html"> PyTorch Neuron (torch-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/torch-neuron.html"> PyTorch Neuron (torch-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuronx.html"> Tensorflow Neuron (tensorflow-neuronx) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/tensorflow-neuron.html"> Tensorflow Neuron (tensorflow-neuron) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/setup/mxnet-neuron.html"> MxNet Neuron (mxnet-neuron) </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../containers/index.html"> Containers Deployment </a> <input class="toctree-checkbox" id="toctree-checkbox-71" name="toctree-checkbox-71" type="checkbox"> <label for="toctree-checkbox-71"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-72" name="toctree-checkbox-72" type="checkbox"> <label for="toctree-checkbox-72"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-73" name="toctree-checkbox-73" type="checkbox"> <label for="toctree-checkbox-73"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/tutorial-infer.html"> Run inference in pytorch neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/k8s_rn50_demo.html"> Deploy a TensorFlow Resnet50 model as a Kubernetes service </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-74" name="toctree-checkbox-74" type="checkbox"> <label for="toctree-checkbox-74"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/tutorial-training.html"> Run training in Pytorch Neuron container </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/k8s_mlp_train_demo.html"> Deploy a simple mlp training script as a Kubernetes job </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-75" name="toctree-checkbox-75" type="checkbox"> <label for="toctree-checkbox-75"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-76" name="toctree-checkbox-76" type="checkbox"> <label for="toctree-checkbox-76"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/devflows/index.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-77" name="toctree-checkbox-77" type="checkbox"> <label for="toctree-checkbox-77"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../containers/index.html"> Deploy Containers with Neuron </a> <input class="toctree-checkbox" id="toctree-checkbox-78" name="toctree-checkbox-78" type="checkbox"> <label for="toctree-checkbox-78"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../containers/locate-neuron-dlc-image.html"> Locate Neuron DLC Image </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/getting-started.html"> Getting Started </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../containers/kubernetes-getting-started.html"> Kubernetes Getting Started </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/tutorials.html"> Tutorials </a> <input class="toctree-checkbox" id="toctree-checkbox-79" name="toctree-checkbox-79" type="checkbox"> <label for="toctree-checkbox-79"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/inference/index.html"> Inference </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/tutorials/training/index.html"> Training </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/developerflows.html"> Developer Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-80" name="toctree-checkbox-80" type="checkbox"> <label for="toctree-checkbox-80"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ec2-devflow.html"> Deploy Neuron Container on EC2 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/container-sm-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../containers/faq-troubleshooting-releasenote.html"> FAQ, Troubleshooting and Release Note </a> <input class="toctree-checkbox" id="toctree-checkbox-81" name="toctree-checkbox-81" type="checkbox"> <label for="toctree-checkbox-81"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../containers/faq.html"> FAQ </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../containers/troubleshooting.html"> Troubleshooting Neuron Containers </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-containers.html"> Neuron Containers Release Notes </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../release-notes/containers/neuron-k8.html"> Neuron K8 Release Notes </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ec2-flows.html"> AWS EC2 </a> <input class="toctree-checkbox" id="toctree-checkbox-82" name="toctree-checkbox-82" type="checkbox"> <label for="toctree-checkbox-82"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ec2-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-83" name="toctree-checkbox-83" type="checkbox"> <label for="toctree-checkbox-83"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow.html"> Compile with Framework API and Deploy on EC2 Inf1 </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/ec2-then-ec2-devflow-inf2.html"> Compile with Framework API and Deploy on EC2 Inf2 </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/ec2-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-84" name="toctree-checkbox-84" type="checkbox"> <label for="toctree-checkbox-84"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/ec2/ec2-training.html"> Train your model on EC2 </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/eks-flows.html"> Amazon EKS </a> <input class="toctree-checkbox" id="toctree-checkbox-85" name="toctree-checkbox-85" type="checkbox"> <label for="toctree-checkbox-85"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/eks-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-86" name="toctree-checkbox-86" type="checkbox"> <label for="toctree-checkbox-86"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-eks-devflow.html"> Deploy Neuron Container on Elastic Kubernetes Service (EKS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/eks-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/ecs-flows.html"> AWS ECS </a> <input class="toctree-checkbox" id="toctree-checkbox-87" name="toctree-checkbox-87" type="checkbox"> <label for="toctree-checkbox-87"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/ecs-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-88" name="toctree-checkbox-88" type="checkbox"> <label for="toctree-checkbox-88"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/dlc-then-ecs-devflow.html"> Deploy Neuron Container on Elastic Container Service (ECS) </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/ecs-flows.html"> Training </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/sagemaker-flows.html"> Sagemaker </a> <input class="toctree-checkbox" id="toctree-checkbox-89" name="toctree-checkbox-89" type="checkbox"> <label for="toctree-checkbox-89"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/inference/sagemaker-flows.html"> Inference </a> <input class="toctree-checkbox" id="toctree-checkbox-90" name="toctree-checkbox-90" type="checkbox"> <label for="toctree-checkbox-90"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow-inf2.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf2 or trn1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/byoc-hosting-devflow.html"> Bring Your Own Neuron Container to Sagemaker Hosting (inf1) </a> </li> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/inference/neo-then-hosting-devflow.html"> Compile with Sagemaker Neo and Deploy on Sagemaker Hosting (inf1) </a> </li> </ul> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/sagemaker-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-91" name="toctree-checkbox-91" type="checkbox"> <label for="toctree-checkbox-91"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/sm-devflow/sm-training-devflow.html"> Train your model on SageMaker </a> </li> </ul> </li> <li class="toctree-l3"> <a class="reference external" href="https://github.com/aws-neuron/aws-neuron-sagemaker-samples"> AWS Neuron Sagemaker Samples GitHub Repository </a> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/parallelcluster-flows.html"> Parallel Cluster </a> <input class="toctree-checkbox" id="toctree-checkbox-92" name="toctree-checkbox-92" type="checkbox"> <label for="toctree-checkbox-92"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/parallelcluster-flows.html"> Inference </a> </li> <li class="toctree-l3 has-children"> <a class="reference internal" href="../../general/devflows/training/parallelcluster-flows.html"> Training </a> <input class="toctree-checkbox" id="toctree-checkbox-93" name="toctree-checkbox-93" type="checkbox"> <label for="toctree-checkbox-93"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l4"> <a class="reference internal" href="../../general/devflows/training/parallelcluster/parallelcluster-training.html"> Train your model on ParallelCluster </a> </li> </ul> </li> </ul> </li> <li class="toctree-l2 has-children"> <a class="reference internal" href="../../general/devflows/aws-batch-flows.html"> AWS Batch Flows </a> <input class="toctree-checkbox" id="toctree-checkbox-94" name="toctree-checkbox-94" type="checkbox"> <label for="toctree-checkbox-94"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/inference/aws-batch-flows.html"> Inference </a> </li> <li class="toctree-l3"> <a class="reference internal" href="../../general/devflows/training/aws-batch-flows.html"> Training </a> </li> </ul> </li> </ul> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> Learning Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/index.html"> Architecture </a> <input class="toctree-checkbox" id="toctree-checkbox-95" name="toctree-checkbox-95" type="checkbox"> <label for="toctree-checkbox-95"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf1-arch.html"> AWS Inf1 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trn1-arch.html"> AWS Trn1/Trn1n Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inf2-arch.html"> AWS Inf2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia.html"> Inferentia Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/inferentia2.html"> Inferentia2 Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/trainium.html"> Trainium Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-hardware/neuroncores-arch.html"> AWS NeuronCore Architecture </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/model-architecture-fit.html"> Neuron Model Architecture Fit Guidelines </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/glossary.html"> Neuron Glossary </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/arch/neuron-features/index.html"> Features </a> <input class="toctree-checkbox" id="toctree-checkbox-96" name="toctree-checkbox-96" type="checkbox"> <label for="toctree-checkbox-96"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/data-types.html"> Data Types </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/rounding-modes.html"> Rounding Modes </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-batching.html"> Neuron Batching </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuroncore-pipeline.html"> NeuronCore Pipeline </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/neuron-caching.html"> Neuron Persistent Cache </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/collective-communication.html"> Collective Communication </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/control-flow.html"> Neuron Control Flow </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/custom-c%2B%2B-operators.html"> Neuron Custom C++ Operators </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/arch/neuron-features/dynamic-shapes.html"> Neuron Dynamic Shapes </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/appnotes/index.html"> Application Notes </a> <input class="toctree-checkbox" id="toctree-checkbox-97" name="toctree-checkbox-97" type="checkbox"> <label for="toctree-checkbox-97"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/announcements/neuron2.x/neuron2-intro.html"> Introducing first release of Neuron 2.x enabling EC2 Trn1 general availability (GA) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/neuron1x/introducing-libnrt.html"> Introducing Neuron Runtime 2.x (libnrt.so) </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/performance-tuning.html"> Performance Tuning </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/perf/neuron-cc/parallel-ncgs.html"> Parallel Execution using NEURON_RT_NUM_CORES </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/torch-neuron/rcnn-app-note.html"> Running R-CNNs on Inf1 </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/appnotes/transformers-neuronx/generative-llm-inference-with-neuron.html"> Generative LLM inference with Neuron </a> </li> </ul> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/faq.html"> FAQ </a> </li> <li class="toctree-l1"> <a class="reference internal" href="../../general/troubleshooting.html"> Troubleshooting </a> </li> </ul> <p aria-level="2" class="caption" role="heading"> <span class="caption-text"> About Neuron </span> </p> <ul class="nav bd-sidenav"> <li class="toctree-l1"> <a class="reference internal" href="../../release-notes/release.html"> Release Details </a> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/roadmap-readme.html"> Roadmap </a> <input class="toctree-checkbox" id="toctree-checkbox-98" name="toctree-checkbox-98" type="checkbox"> <label for="toctree-checkbox-98"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference external" href="https://github.com/orgs/aws-neuron/projects/1/views/1"> Neuron Public Roadmap </a> </li> </ul> </li> <li class="toctree-l1 has-children"> <a class="reference internal" href="../../general/support.html"> Support </a> <input class="toctree-checkbox" id="toctree-checkbox-99" name="toctree-checkbox-99" type="checkbox"> <label for="toctree-checkbox-99"> <i class="fas fa-chevron-down"> </i> </label> <ul> <li class="toctree-l2"> <a class="reference internal" href="../../general/sdk-policy.html"> SDK Maintenance Policy </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/security.html"> Security Disclosures </a> </li> <li class="toctree-l2"> <a class="reference internal" href="../../general/contact.html"> Contact Us </a> </li> </ul> </li> </ul> </div> </nav></div> <div class="bd-sidebar__bottom"> <!-- To handle the deprecated key --> <div class="navbar_extra_footer"> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a> </div> </div> </div> <div id="rtd-footer-container"></div> </div> <!-- A tiny helper pixel to detect if we've scrolled --> <div class="sbt-scroll-pixel-helper"></div> <!-- Main content --> <div class="col py-0 content-container"> <div class="header-article row sticky-top noprint"> <div class="col py-1 d-flex header-article-main"> <div class="header-article__left"> <label for="__navigation" class="headerbtn" data-toggle="tooltip" data-placement="right" title="" data-original-title="Toggle navigation"> <span class="headerbtn__icon-container"> <i class="fas fa-bars"></i> </span> </label> </div> <div class="header-article__right"> <button onclick="toggleFullScreen()" class="headerbtn" data-toggle="tooltip" data-placement="bottom" title="" data-original-title="Fullscreen mode"> <span class="headerbtn__icon-container"> <i class="fas fa-expand"></i> </span> </button> <div class="menu-dropdown menu-dropdown-repository-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Source repositories"> <i class="fab fa-github"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Source repository"> <span class="headerbtn__icon-container"> <i class="fab fa-github"></i> </span> <span class="headerbtn__text-container">repository</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/issues/new?title=Issue%20on%20page%20%2Fframeworks/tensorflow/training.html&amp;body=Your%20issue%20content%20here." class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Open an issue"> <span class="headerbtn__icon-container"> <i class="fas fa-lightbulb"></i> </span> <span class="headerbtn__text-container">open issue</span> </a> </li> <li> <a href="https://github.com/aws-neuron/aws-neuron-sdk/edit/v2.14.1/frameworks/tensorflow/training.rst" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Edit this page"> <span class="headerbtn__icon-container"> <i class="fas fa-pencil-alt"></i> </span> <span class="headerbtn__text-container">suggest edit</span> </a> </li> </ul> </div> </div> <div class="menu-dropdown menu-dropdown-download-buttons"> <button class="headerbtn menu-dropdown__trigger" aria-label="Download this page"> <i class="fas fa-download"></i> </button> <div class="menu-dropdown__content"> <ul> <li> <a href="../../_sources/frameworks/tensorflow/training.rst.txt" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Download source file"> <span class="headerbtn__icon-container"> <i class="fas fa-file"></i> </span> <span class="headerbtn__text-container">.rst</span> </a> </li> <li> <button onclick="printPdf(this)" class="headerbtn" data-toggle="tooltip" data-placement="left" title="" data-original-title="Print to PDF"> <span class="headerbtn__icon-container"> <i class="fas fa-file-pdf"></i> </span> <span class="headerbtn__text-container">.pdf</span> </button> </li> </ul> </div> </div> </div> </div> <!-- Table of contents --> <div class="col-md-3 bd-toc show noprint"> </div> </div> <div class="article row"> <div class="col pl-md-3 pl-lg-5 content-container"> <!-- Table of contents that is only displayed when printing the page --> <div id="jb-print-docs-body" class="onlyprint"> <h1>Training</h1> <!-- Table of contents --> <div id="print-main-content"> <div id="jb-print-toc"> </div> </div> </div> <main id="main-content" role="main"> <div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> <div class="section" id="training"> <h1>Training<a class="headerlink" href="#training" title="Permalink to this headline">#</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> <p>TensorFlow Neuron support for Training is coming soon.</p> </div> <p><em>This document is relevant for</em>: <code class="docutils literal notranslate"><span class="pre">Inf1</span></code>, <code class="docutils literal notranslate"><span class="pre">Inf2</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1</span></code>, <code class="docutils literal notranslate"><span class="pre">Trn1n</span></code></p> </div> <div class="section"> </div> </div> </main> <footer class="footer-article noprint"> <!-- Previous / next buttons --> <div class="prev-next-area"> <a class="left-prev" id="prev-link" href="../../release-notes/compiler/neuron-cc/neuron-cc-ops/neuron-cc-ops-tensorflow.html" title="previous page"> <i class="fas fa-angle-left"></i> <div class="prev-next-info"> <p class="prev-next-subtitle">previous</p> <p class="prev-next-title">TensorFlow Neuron (<code class="docutils literal notranslate"><span class="pre">tensorflow-neuron</span> <span class="pre">(TF1.x)</span></code>) Supported operators</p> </div> </a> <a class="right-next" id="next-link" href="../mxnet-neuron/index.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">MXNet Neuron</p> </div> <i class="fas fa-angle-right"></i> </a> </div> </footer> </div> </div> <div class="footer-content row"> <footer class="col footer"><p> By AWS<br> © Copyright 2023, Amazon.com.<br> </p> </footer> </div> </div> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> </body></html>
2023-09-29T20:53:21.820Z